AppFlow

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

AppFlowConnector # CLOUD CONTROL · AWS::AppFlow::Connector

AppFlowConnector manages AWS::AppFlow::Connector through the AWS Cloud Control API.

kubectl get appflowconnectors · example on GitHub

Example

# AppFlowConnector — AppFlow
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/appflow.html#appflowconnector
apiVersion: aws.konfig.io/v1alpha1
kind: AppFlowConnector
metadata:
  name: example-appflowconnector
  namespace: default
spec:
  connectorLabel: example
  connectorProvisioningConfig:
    lambda:
      lambdaArn: arn:aws:iam::123456789012:role/example-role
  connectorProvisioningType: example
  description: Managed by konfig-konector
  providerRef:
    name: example-appflowconnector
    region: us-east-1

Spec

FieldTypeRequiredDescription
connectorLabelstring—The name of the connector.
connectorProvisioningConfigobjectyesContains information about the configuration of the connector being registered.
connectorProvisioningConfig.lambdaobject—Contains information about the configuration of the lambda which is being registered as the connector.
connectorProvisioningConfig.lambda.lambdaArnstringyesLambda ARN of the connector being registered.
connectorProvisioningTypestringyesThe provisioning type of the connector.
descriptionstring—A description about the connector that's being registered.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
connectorArnstring—The arn of the connector.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

AppFlowConnectorProfile # CLOUD CONTROL · AWS::AppFlow::ConnectorProfile

AppFlowConnectorProfile manages AWS::AppFlow::ConnectorProfile through the AWS Cloud Control API.

kubectl get appflowconnectorprofiles · example on GitHub

Example

# AppFlowConnectorProfile — AppFlow
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/appflow.html#appflowconnectorprofile
apiVersion: aws.konfig.io/v1alpha1
kind: AppFlowConnectorProfile
metadata:
  name: example-appflowconnectorprofile
  namespace: default
spec:
  connectionMode: Public
  connectorLabel: example
  connectorProfileConfig:
    connectorProfileCredentials:
      amplitude:
        apiKey: example
        secretKey: example
      customConnector:
        authenticationType: OAUTH2
      datadog:
        apiKey: example
        applicationKey: example
      dynatrace:
        apiToken: example
      googleAnalytics:
        accessToken: example
        clientId: example-id
        clientSecret: example
        refreshToken: example
      inforNexus:
        accessKeyId: example-id
        datakey: example
        secretAccessKey: example
        userId: example-id
      marketo:
        accessToken: example
        clientId: example-id
        clientSecret: example
      pardot:
        accessToken: example
        clientCredentialsArn: arn:aws:iam::123456789012:role/example-role
        refreshToken: example
      redshift:
        password: example
        username: example-appflowconnectorprofile
      salesforce:
        accessToken: example
        clientCredentialsArn: arn:aws:iam::123456789012:role/example-role
        jwtToken: example
        oAuth2GrantType: CLIENT_CREDENTIALS
        refreshToken: example
      serviceNow:
        password: example
        username: example-appflowconnectorprofile
      singular:
        apiKey: example
      slack:
        accessToken: example
        clientId: example-id
        clientSecret: example
      snowflake:
        password: example
        username: example-appflowconnectorprofile
      trendmicro:
        apiSecretKey: example
      veeva:
        password: example
        username: example-appflowconnectorprofile
      zendesk:
        accessToken: example
        clientId: example-id
        clientSecret: example
    connectorProfileProperties:
      datadog:
        instanceUrl: example
      dynatrace:
        instanceUrl: example
      inforNexus:
        instanceUrl: example
      marketo:
        instanceUrl: example
      pardot:
        businessUnitId: example-id
        instanceUrl: example
        isSandboxEnvironment: false
      redshift:
        bucketName: example-appflowconnectorprofile
        bucketPrefix: example
        clusterIdentifier: example
        dataApiRoleArn: arn:aws:iam::123456789012:role/example-role
        databaseName: example-appflowconnectorprofile
        databaseUrl: example
        isRedshiftServerless: false
        roleArn: arn:aws:iam::123456789012:role/example-role
        workgroupName: example-appflowconnectorprofile
      salesforce:
        instanceUrl: example
        isSandboxEnvironment: false
        usePrivateLinkForMetadataAndAuthorization: false
      sapoData:
        applicationHostUrl: example
        applicationServicePath: example
        clientNumber: exa
        disableSSO: false
        logonLanguage: ex
        portNumber: 1
        privateLinkServiceName: example-appflowconnectorprofile
      serviceNow:
        instanceUrl: example
      slack:
        instanceUrl: example
      snowflake:
        accountName: example-appflowconnectorprofile
        bucketName: example-appflowconnectorprofile
        bucketPrefix: example
        privateLinkServiceName: example-appflowconnectorprofile
        region: us-east-1
        stage: example
        warehouse: example
      veeva:
        instanceUrl: example
      zendesk:
        instanceUrl: example
  connectorProfileName: example-appflowconnectorprofile
  connectorType: Salesforce
  kmsArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-appflowconnectorprofile
    region: us-east-1

Spec

FieldTypeRequiredDescription
connectionModeenumyesMode in which data transfer should be enabled. Allowed: Public, Private
connectorLabelstring—The label of the connector.
connectorProfileConfigobject—Connector specific configurations needed to create connector profile
connectorProfileConfig.connectorProfileCredentialsobject—AppFlowConnectorProfileConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.amplitudeobject—AppFlowConnectorProfileAmplitudeConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.amplitude.apiKeystringyesA unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
connectorProfileConfig.connectorProfileCredentials.amplitude.secretKeystringyes
connectorProfileConfig.connectorProfileCredentials.customConnectorobject—AppFlowConnectorProfileCustomConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKeyobject—AppFlowConnectorProfileApiKeyCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKey.apiKeystringyes
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKey.apiSecretKeystring—
connectorProfileConfig.connectorProfileCredentials.customConnector.authenticationTypeenumyesAllowed: OAUTH2, APIKEY, BASIC, CUSTOM
connectorProfileConfig.connectorProfileCredentials.customConnector.basicobject—AppFlowConnectorProfileBasicAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.basic.passwordstringyes
connectorProfileConfig.connectorProfileCredentials.customConnector.basic.usernamestringyes
connectorProfileConfig.connectorProfileCredentials.customConnector.customobject—AppFlowConnectorProfileCustomAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.custom.credentialsMapmap<string>—
connectorProfileConfig.connectorProfileCredentials.customConnector.custom.customAuthenticationTypestringyes
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2object—AppFlowConnectorProfileOAuth2Credentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.accessTokenstring—
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.clientIdstring—
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.clientSecretstring—
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequestobject—AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.refreshTokenstring—
connectorProfileConfig.connectorProfileCredentials.datadogobject—AppFlowConnectorProfileDatadogConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.datadog.apiKeystringyesA unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
connectorProfileConfig.connectorProfileCredentials.datadog.applicationKeystringyesApplication keys, in conjunction with your API key, give you full access to Datadog’s programmatic API.
connectorProfileConfig.connectorProfileCredentials.dynatraceobject—AppFlowConnectorProfileDynatraceConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.dynatrace.apiTokenstringyesThe API tokens used by Dynatrace API to authenticate various API calls.
connectorProfileConfig.connectorProfileCredentials.googleAnalyticsobject—AppFlowConnectorProfileGoogleAnalyticsConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.clientIdstringyesThe identifier for the desired client.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.clientSecretstringyesThe client secret used by the oauth client to authenticate to the authorization server.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.refreshTokenstring—The credentials used to acquire new access tokens.
connectorProfileConfig.connectorProfileCredentials.inforNexusobject—AppFlowConnectorProfileInforNexusConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.inforNexus.accessKeyIdstringyesThe Access Key portion of the credentials.
connectorProfileConfig.connectorProfileCredentials.inforNexus.datakeystringyesThe encryption keys used to encrypt data.
connectorProfileConfig.connectorProfileCredentials.inforNexus.secretAccessKeystringyesThe secret key used to sign requests.
connectorProfileConfig.connectorProfileCredentials.inforNexus.userIdstringyesThe identifier for the user.
connectorProfileConfig.connectorProfileCredentials.marketoobject—AppFlowConnectorProfileMarketoConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.marketo.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.marketo.clientIdstringyesThe identifier for the desired client.
connectorProfileConfig.connectorProfileCredentials.marketo.clientSecretstringyesThe client secret used by the oauth client to authenticate to the authorization server.
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.pardotobject—AppFlowConnectorProfilePardotConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.pardot.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.pardot.clientCredentialsArnstring—The client credentials to fetch access token and refresh token.
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.pardot.refreshTokenstring—The credentials used to acquire new access tokens.
connectorProfileConfig.connectorProfileCredentials.redshiftobject—AppFlowConnectorProfileRedshiftConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.redshift.passwordstring—The password that corresponds to the username.
connectorProfileConfig.connectorProfileCredentials.redshift.usernamestring—The name of the user.
connectorProfileConfig.connectorProfileCredentials.salesforceobject—AppFlowConnectorProfileSalesforceConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.salesforce.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.salesforce.clientCredentialsArnstring—The client credentials to fetch access token and refresh token.
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.salesforce.jwtTokenstring—The credentials used to access your Salesforce records
connectorProfileConfig.connectorProfileCredentials.salesforce.oAuth2GrantTypeenum—The grant types to fetch an access token Allowed: CLIENT_CREDENTIALS, AUTHORIZATION_CODE, JWT_BEARER
connectorProfileConfig.connectorProfileCredentials.salesforce.refreshTokenstring—The credentials used to acquire new access tokens.
connectorProfileConfig.connectorProfileCredentials.sapoDataobject—AppFlowConnectorProfileSAPODataConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentialsobject—AppFlowConnectorProfileBasicAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentials.passwordstringyes
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentials.usernamestringyes
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentialsobject—AppFlowConnectorProfileSAPODataConnectorProfileCredentialsOAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.accessTokenstring—
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.clientIdstring—
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.clientSecretstring—
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequestobject—AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.refreshTokenstring—
connectorProfileConfig.connectorProfileCredentials.serviceNowobject—AppFlowConnectorProfileServiceNowConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentialsobject—The OAuth 2.0 credentials required to authenticate the user.
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.accessTokenstring—
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.clientIdstring—
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.clientSecretstring—
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequestobject—AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.refreshTokenstring—
connectorProfileConfig.connectorProfileCredentials.serviceNow.passwordstring—The password that corresponds to the username.
connectorProfileConfig.connectorProfileCredentials.serviceNow.usernamestring—The name of the user.
connectorProfileConfig.connectorProfileCredentials.singularobject—AppFlowConnectorProfileSingularConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.singular.apiKeystringyesA unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
connectorProfileConfig.connectorProfileCredentials.slackobject—AppFlowConnectorProfileSlackConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.slack.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.slack.clientIdstringyesThe identifier for the desired client.
connectorProfileConfig.connectorProfileCredentials.slack.clientSecretstringyesThe client secret used by the oauth client to authenticate to the authorization server.
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfileCredentials.snowflakeobject—AppFlowConnectorProfileSnowflakeConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.snowflake.passwordstringyesThe password that corresponds to the username.
connectorProfileConfig.connectorProfileCredentials.snowflake.usernamestringyesThe name of the user.
connectorProfileConfig.connectorProfileCredentials.trendmicroobject—AppFlowConnectorProfileTrendmicroConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.trendmicro.apiSecretKeystringyesThe Secret Access Key portion of the credentials.
connectorProfileConfig.connectorProfileCredentials.veevaobject—AppFlowConnectorProfileVeevaConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.veeva.passwordstringyesThe password that corresponds to the username.
connectorProfileConfig.connectorProfileCredentials.veeva.usernamestringyesThe name of the user.
connectorProfileConfig.connectorProfileCredentials.zendeskobject—AppFlowConnectorProfileZendeskConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileCredentials.zendesk.accessTokenstring—The credentials used to access protected resources.
connectorProfileConfig.connectorProfileCredentials.zendesk.clientIdstringyesThe identifier for the desired client.
connectorProfileConfig.connectorProfileCredentials.zendesk.clientSecretstringyesThe client secret used by the oauth client to authenticate to the authorization server.
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequestobject—The oauth needed to request security tokens from the connector endpoint.
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequest.authCodestring—The code provided by the connector when it has been authenticated via the connected app.
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequest.redirectUristring—The URL to which the authentication server redirects the browser after authorization has been granted.
connectorProfileConfig.connectorProfilePropertiesobject—AppFlowConnectorProfileConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.customConnectorobject—AppFlowConnectorProfileCustomConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Propertiesobject—AppFlowConnectorProfileOAuth2Properties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.oAuth2GrantTypeenum—Allowed: CLIENT_CREDENTIALS, AUTHORIZATION_CODE, JWT_BEARER
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.tokenUrlstring—
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.tokenUrlCustomPropertiesmap<string>—
connectorProfileConfig.connectorProfileProperties.customConnector.profilePropertiesmap<string>—
connectorProfileConfig.connectorProfileProperties.datadogobject—AppFlowConnectorProfileDatadogConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.datadog.instanceUrlstringyesThe location of the Datadog resource
connectorProfileConfig.connectorProfileProperties.dynatraceobject—AppFlowConnectorProfileDynatraceConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.dynatrace.instanceUrlstringyesThe location of the Dynatrace resource
connectorProfileConfig.connectorProfileProperties.inforNexusobject—AppFlowConnectorProfileInforNexusConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.inforNexus.instanceUrlstringyesThe location of the InforNexus resource
connectorProfileConfig.connectorProfileProperties.marketoobject—AppFlowConnectorProfileMarketoConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.marketo.instanceUrlstringyesThe location of the Marketo resource
connectorProfileConfig.connectorProfileProperties.pardotobject—AppFlowConnectorProfilePardotConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.pardot.businessUnitIdstringyesThe Business unit id of Salesforce Pardot instance to be connected
connectorProfileConfig.connectorProfileProperties.pardot.instanceUrlstring—The location of the Salesforce Pardot resource
connectorProfileConfig.connectorProfileProperties.pardot.isSandboxEnvironmentboolean—Indicates whether the connector profile applies to a demo or production environment
connectorProfileConfig.connectorProfileProperties.redshiftobject—AppFlowConnectorProfileRedshiftConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.redshift.bucketNamestringyesThe name of the Amazon S3 bucket associated with Redshift.
connectorProfileConfig.connectorProfileProperties.redshift.bucketPrefixstring—The object key for the destination bucket in which Amazon AppFlow will place the files.
connectorProfileConfig.connectorProfileProperties.redshift.clusterIdentifierstring—The unique identifier of the Amazon Redshift cluster.
connectorProfileConfig.connectorProfileProperties.redshift.dataApiRoleArnstring—The Amazon Resource Name (ARN) of the IAM role that grants Amazon AppFlow access to the data through the Amazon Redshift Data API.
connectorProfileConfig.connectorProfileProperties.redshift.databaseNamestring—The name of the Amazon Redshift database that will store the transferred data.
connectorProfileConfig.connectorProfileProperties.redshift.databaseUrlstring—The JDBC URL of the Amazon Redshift cluster.
connectorProfileConfig.connectorProfileProperties.redshift.isRedshiftServerlessboolean—If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster.
connectorProfileConfig.connectorProfileProperties.redshift.roleArnstringyesThe Amazon Resource Name (ARN) of the IAM role.
connectorProfileConfig.connectorProfileProperties.redshift.workgroupNamestring—The name of the Amazon Redshift serverless workgroup
connectorProfileConfig.connectorProfileProperties.salesforceobject—AppFlowConnectorProfileSalesforceConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.salesforce.instanceUrlstring—The location of the Salesforce resource
connectorProfileConfig.connectorProfileProperties.salesforce.isSandboxEnvironmentboolean—Indicates whether the connector profile applies to a sandbox or production environment
connectorProfileConfig.connectorProfileProperties.salesforce.usePrivateLinkForMetadataAndAuthorizationboolean—Indicates whether to make Metadata And Authorization calls over Pivate Network
connectorProfileConfig.connectorProfileProperties.sapoDataobject—AppFlowConnectorProfileSAPODataConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.sapoData.applicationHostUrlstring—
connectorProfileConfig.connectorProfileProperties.sapoData.applicationServicePathstring—
connectorProfileConfig.connectorProfileProperties.sapoData.clientNumberstring—
connectorProfileConfig.connectorProfileProperties.sapoData.disableSSOboolean—If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.
connectorProfileConfig.connectorProfileProperties.sapoData.logonLanguagestring—
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthPropertiesobject—AppFlowConnectorProfileOAuthProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.authCodeUrlstring—
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.oAuthScopesarray<string>—
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.tokenUrlstring—
connectorProfileConfig.connectorProfileProperties.sapoData.portNumberinteger—
connectorProfileConfig.connectorProfileProperties.sapoData.privateLinkServiceNamestring—
connectorProfileConfig.connectorProfileProperties.serviceNowobject—AppFlowConnectorProfileServiceNowConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.serviceNow.instanceUrlstringyesThe location of the ServiceNow resource
connectorProfileConfig.connectorProfileProperties.slackobject—AppFlowConnectorProfileSlackConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.slack.instanceUrlstringyesThe location of the Slack resource
connectorProfileConfig.connectorProfileProperties.snowflakeobject—AppFlowConnectorProfileSnowflakeConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.snowflake.accountNamestring—The name of the account.
connectorProfileConfig.connectorProfileProperties.snowflake.bucketNamestringyesThe name of the Amazon S3 bucket associated with Snowflake.
connectorProfileConfig.connectorProfileProperties.snowflake.bucketPrefixstring—The bucket prefix that refers to the Amazon S3 bucket associated with Snowflake.
connectorProfileConfig.connectorProfileProperties.snowflake.privateLinkServiceNamestring—The Snowflake Private Link service name to be used for private data transfers.
connectorProfileConfig.connectorProfileProperties.snowflake.regionstring—The region of the Snowflake account.
connectorProfileConfig.connectorProfileProperties.snowflake.stagestringyesThe name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account.
connectorProfileConfig.connectorProfileProperties.snowflake.warehousestringyesThe name of the Snowflake warehouse.
connectorProfileConfig.connectorProfileProperties.veevaobject—AppFlowConnectorProfileVeevaConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.veeva.instanceUrlstringyesThe location of the Veeva resource
connectorProfileConfig.connectorProfileProperties.zendeskobject—AppFlowConnectorProfileZendeskConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile.
connectorProfileConfig.connectorProfileProperties.zendesk.instanceUrlstringyesThe location of the Zendesk resource
connectorProfileNamestringyesThe maximum number of items to retrieve in a single batch.
connectorTypeenumyesList of Saas providers that need connector profile to be created Create-only in AWS: changing it requires replacing the resource. Allowed: Salesforce, Pardot, Singular, Slack, Redshift, Marketo, Googleanalytics, Zendesk…
kmsArnstring—The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
connectorProfileArnstring—Unique identifier for connector profile resources Read-only: reported by AWS after creation.
credentialsArnstring—A unique Arn for Connector-Profile resource Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

AppFlowFlow # CLOUD CONTROL · AWS::AppFlow::Flow

AppFlowFlow manages AWS::AppFlow::Flow through the AWS Cloud Control API.

kubectl get appflowflows · example on GitHub

Example

# AppFlowFlow — AppFlow
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/appflow.html#appflowflow
apiVersion: aws.konfig.io/v1alpha1
kind: AppFlowFlow
metadata:
  name: example-appflowflow
  namespace: default
spec:
  description: Managed by konfig-konector
  destinationFlowConfigList:
  - apiVersion: '1.0'
    connectorProfileName: example-appflowflow
    connectorType: SAPOData
  flowName: example-appflowflow
  flowStatus: Active
  kmsArn: arn:aws:iam::123456789012:role/example-role
  metadataCatalogConfig:
    glueDataCatalog:
      databaseName: example-appflowflow
      roleArn: arn:aws:iam::123456789012:role/example-role
      tablePrefix: example
  providerRef:
    name: example-appflowflow
    region: us-east-1
  sourceFlowConfig:
    apiVersion: '1.0'
    connectorProfileName: example-appflowflow
    connectorType: SAPOData
    incrementalPullConfig:
      datetimeTypeFieldName: example-appflowflow
    sourceConnectorProperties:
      amplitude:
        object: example
      customConnector:
        entityName: example-appflowflow
      datadog:
        object: example
      dynatrace:
        object: example
      googleAnalytics:
        object: example
      inforNexus:
        object: example
      marketo:
        object: example
      pardot:
        object: example
      s3:
        bucketName: example-appflowflow
        bucketPrefix: example
      salesforce:
        dataTransferApi: AUTOMATIC
        enableDynamicFieldUpdate: true
        includeDeletedRecords: false
        object: example
      sapoData:
        objectPath: example
      serviceNow:
        object: example
      singular:
        object: example
      slack:
        object: example
      trendmicro:
        object: example
      veeva:
        documentType: example
        includeAllVersions: false
        includeRenditions: false
        includeSourceFiles: false
        object: example
      zendesk:
        object: example
  tags:
  - key: example
    value: example
  tasks:
  - connectorOperator:
      amplitude: BETWEEN
      customConnector: PROJECTION
      datadog: PROJECTION
      dynatrace: PROJECTION
      googleAnalytics: PROJECTION
      inforNexus: PROJECTION
      marketo: PROJECTION
      pardot: PROJECTION
      s3: PROJECTION
      salesforce: PROJECTION
      sapoData: PROJECTION
      serviceNow: PROJECTION
      singular: PROJECTION
      slack: PROJECTION
      trendmicro: PROJECTION
      veeva: PROJECTION
      zendesk: PROJECTION
    destinationField: example
    sourceFields:
    - example
    taskProperties:
    - key: VALUE
      value: example
    taskType: Arithmetic
  triggerConfig:
    triggerProperties:
      dataPullMode: Incremental
      firstExecutionFrom: 1
      flowErrorDeactivationThreshold: 1
      scheduleEndTime: 1
      scheduleExpression: example
      scheduleOffset: 1
      scheduleStartTime: 1
      timeZone: example
    triggerType: Scheduled

Spec

FieldTypeRequiredDescription
descriptionstring—Description of the flow.
destinationFlowConfigListarray<object>yesList of Destination connectors of the flow.
destinationFlowConfigList[].apiVersionstring—The API version that the destination connector uses.
destinationFlowConfigList[].connectorProfileNamestring—Name of destination connector profile
destinationFlowConfigList[].connectorTypeenumyesDestination connector type Allowed: SAPOData, Salesforce, Pardot, Singular, Slack, Redshift, S3, Marketo…
destinationFlowConfigList[].destinationConnectorPropertiesobjectyesDestination connector details
destinationFlowConfigList[].destinationConnectorProperties.customConnectorobject—AppFlowFlowCustomConnectorDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.customConnector.customPropertiesmap<string>—
destinationFlowConfigList[].destinationConnectorProperties.customConnector.entityNamestringyes
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.customConnector.idFieldNamesarray<string>—List of fields used as ID when performing a write operation.
destinationFlowConfigList[].destinationConnectorProperties.customConnector.writeOperationTypeenum—Allowed: INSERT, UPSERT, UPDATE, DELETE
destinationFlowConfigList[].destinationConnectorProperties.eventBridgeobject—AppFlowFlowEventBridgeDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.lookoutMetricsobject—AppFlowFlowLookoutMetricsDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.lookoutMetrics.objectstring—
destinationFlowConfigList[].destinationConnectorProperties.marketoobject—AppFlowFlowMarketoDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.marketo.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.redshiftobject—AppFlowFlowRedshiftDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.redshift.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.redshift.intermediateBucketNamestringyes
destinationFlowConfigList[].destinationConnectorProperties.redshift.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.s3object—AppFlowFlowS3DestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.s3.bucketNamestringyes
destinationFlowConfigList[].destinationConnectorProperties.s3.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfigobject—AppFlowFlowS3OutputFormatConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfigobject—AppFlowFlowAggregationConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfig.aggregationTypeenum—Allowed: None, SingleFile
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfig.targetFileSizeinteger—
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.fileTypeenum—Allowed: CSV, JSON, PARQUET
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfigobject—AppFlowFlowPrefixConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.pathPrefixHierarchyarray<string>—
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.prefixFormatenum—Allowed: YEAR, MONTH, DAY, HOUR, MINUTE
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.prefixTypeenum—Allowed: FILENAME, PATH, PATH_AND_FILENAME
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.preserveSourceDataTypingboolean—
destinationFlowConfigList[].destinationConnectorProperties.salesforceobject—AppFlowFlowSalesforceDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.salesforce.dataTransferApienum—Allowed: AUTOMATIC, BULKV2, REST_SYNC
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.salesforce.idFieldNamesarray<string>—List of fields used as ID when performing a write operation.
destinationFlowConfigList[].destinationConnectorProperties.salesforce.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.salesforce.writeOperationTypeenum—Allowed: INSERT, UPSERT, UPDATE, DELETE
destinationFlowConfigList[].destinationConnectorProperties.sapoDataobject—AppFlowFlowSAPODataDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.sapoData.idFieldNamesarray<string>—List of fields used as ID when performing a write operation.
destinationFlowConfigList[].destinationConnectorProperties.sapoData.objectPathstringyes
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfigobject—AppFlowFlowSuccessResponseHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.sapoData.writeOperationTypeenum—Allowed: INSERT, UPSERT, UPDATE, DELETE
destinationFlowConfigList[].destinationConnectorProperties.snowflakeobject—AppFlowFlowSnowflakeDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.snowflake.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.snowflake.intermediateBucketNamestringyes
destinationFlowConfigList[].destinationConnectorProperties.snowflake.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.upsolverobject—AppFlowFlowUpsolverDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.upsolver.bucketNamestringyes
destinationFlowConfigList[].destinationConnectorProperties.upsolver.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfigobjectyesAppFlowFlowUpsolverS3OutputFormatConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfigobject—AppFlowFlowAggregationConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfig.aggregationTypeenum—Allowed: None, SingleFile
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfig.targetFileSizeinteger—
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.fileTypeenum—Allowed: CSV, JSON, PARQUET
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfigobjectyesAppFlowFlowPrefixConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.pathPrefixHierarchyarray<string>—
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.prefixFormatenum—Allowed: YEAR, MONTH, DAY, HOUR, MINUTE
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.prefixTypeenum—Allowed: FILENAME, PATH, PATH_AND_FILENAME
destinationFlowConfigList[].destinationConnectorProperties.zendeskobject—AppFlowFlowZendeskDestinationProperties is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfigobject—AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow.
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.bucketNamestring—
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.bucketPrefixstring—
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.failOnFirstErrorboolean—
destinationFlowConfigList[].destinationConnectorProperties.zendesk.idFieldNamesarray<string>—List of fields used as ID when performing a write operation.
destinationFlowConfigList[].destinationConnectorProperties.zendesk.objectstringyes
destinationFlowConfigList[].destinationConnectorProperties.zendesk.writeOperationTypeenum—Allowed: INSERT, UPSERT, UPDATE, DELETE
flowNamestringyesName of the flow.
flowStatusenum—Flow activation status for Scheduled- and Event-triggered flows Allowed: Active, Suspended, Draft
kmsArnstring—The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables.
metadataCatalogConfigobject—Configurations of metadata catalog of the flow.
metadataCatalogConfig.glueDataCatalogobject—Configurations of glue data catalog of the flow.
metadataCatalogConfig.glueDataCatalog.databaseNamestringyesA string containing the value for the tag
metadataCatalogConfig.glueDataCatalog.roleArnstringyesA string containing the value for the tag
metadataCatalogConfig.glueDataCatalog.tablePrefixstringyesA string containing the value for the tag
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
sourceFlowConfigobjectyesConfigurations of Source connector of the flow.
sourceFlowConfig.apiVersionstring—The API version that the destination connector uses.
sourceFlowConfig.connectorProfileNamestring—Name of source connector profile
sourceFlowConfig.connectorTypeenumyesType of source connector Allowed: SAPOData, Salesforce, Pardot, Singular, Slack, Redshift, S3, Marketo…
sourceFlowConfig.incrementalPullConfigobject—Configuration for scheduled incremental data pull
sourceFlowConfig.incrementalPullConfig.datetimeTypeFieldNamestring—
sourceFlowConfig.sourceConnectorPropertiesobjectyesSource connector details required to query a connector
sourceFlowConfig.sourceConnectorProperties.amplitudeobject—AppFlowFlowAmplitudeSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.amplitude.objectstringyes
sourceFlowConfig.sourceConnectorProperties.customConnectorobject—AppFlowFlowCustomConnectorSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.customConnector.customPropertiesmap<string>—
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApiobject—AppFlowFlowCustomConnectorSourcePropertiesDataTransferApi is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApi.namestringyes
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApi.typeenumyesAllowed: SYNC, ASYNC, AUTOMATIC
sourceFlowConfig.sourceConnectorProperties.customConnector.entityNamestringyes
sourceFlowConfig.sourceConnectorProperties.datadogobject—AppFlowFlowDatadogSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.datadog.objectstringyes
sourceFlowConfig.sourceConnectorProperties.dynatraceobject—AppFlowFlowDynatraceSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.dynatrace.objectstringyes
sourceFlowConfig.sourceConnectorProperties.googleAnalyticsobject—AppFlowFlowGoogleAnalyticsSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.googleAnalytics.objectstringyes
sourceFlowConfig.sourceConnectorProperties.inforNexusobject—AppFlowFlowInforNexusSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.inforNexus.objectstringyes
sourceFlowConfig.sourceConnectorProperties.marketoobject—AppFlowFlowMarketoSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.marketo.objectstringyes
sourceFlowConfig.sourceConnectorProperties.pardotobject—AppFlowFlowPardotSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.pardot.objectstringyes
sourceFlowConfig.sourceConnectorProperties.s3object—AppFlowFlowS3SourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.s3.bucketNamestringyes
sourceFlowConfig.sourceConnectorProperties.s3.bucketPrefixstringyes
sourceFlowConfig.sourceConnectorProperties.s3.s3InputFormatConfigobject—AppFlowFlowS3InputFormatConfig is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.s3.s3InputFormatConfig.s3InputFileTypeenum—Allowed: CSV, JSON
sourceFlowConfig.sourceConnectorProperties.salesforceobject—AppFlowFlowSalesforceSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.salesforce.dataTransferApienum—Allowed: AUTOMATIC, BULKV2, REST_SYNC
sourceFlowConfig.sourceConnectorProperties.salesforce.enableDynamicFieldUpdateboolean—
sourceFlowConfig.sourceConnectorProperties.salesforce.includeDeletedRecordsboolean—
sourceFlowConfig.sourceConnectorProperties.salesforce.objectstringyes
sourceFlowConfig.sourceConnectorProperties.sapoDataobject—AppFlowFlowSAPODataSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.sapoData.objectPathstringyes
sourceFlowConfig.sourceConnectorProperties.sapoData.paginationConfigobject—AppFlowFlowSAPODataPaginationConfig is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.sapoData.paginationConfig.maxPageSizeintegeryes
sourceFlowConfig.sourceConnectorProperties.sapoData.parallelismConfigobject—AppFlowFlowSAPODataParallelismConfig is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.sapoData.parallelismConfig.maxParallelismintegeryes
sourceFlowConfig.sourceConnectorProperties.serviceNowobject—AppFlowFlowServiceNowSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.serviceNow.objectstringyes
sourceFlowConfig.sourceConnectorProperties.singularobject—AppFlowFlowSingularSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.singular.objectstringyes
sourceFlowConfig.sourceConnectorProperties.slackobject—AppFlowFlowSlackSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.slack.objectstringyes
sourceFlowConfig.sourceConnectorProperties.trendmicroobject—AppFlowFlowTrendmicroSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.trendmicro.objectstringyes
sourceFlowConfig.sourceConnectorProperties.veevaobject—AppFlowFlowVeevaSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.veeva.documentTypestring—
sourceFlowConfig.sourceConnectorProperties.veeva.includeAllVersionsboolean—
sourceFlowConfig.sourceConnectorProperties.veeva.includeRenditionsboolean—
sourceFlowConfig.sourceConnectorProperties.veeva.includeSourceFilesboolean—
sourceFlowConfig.sourceConnectorProperties.veeva.objectstringyes
sourceFlowConfig.sourceConnectorProperties.zendeskobject—AppFlowFlowZendeskSourceProperties is a nested property type of AWS::AppFlow::Flow.
sourceFlowConfig.sourceConnectorProperties.zendesk.objectstringyes
tagsarray<object>—List of Tags.
tags[].keystringyes
tags[].valuestringyes
tasksarray<object>yesList of tasks for the flow.
tasks[].connectorOperatorobject—Operation to be performed on provided source fields
tasks[].connectorOperator.amplitudeenum—Allowed: BETWEEN
tasks[].connectorOperator.customConnectorenum—Allowed: PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO…
tasks[].connectorOperator.datadogenum—Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL…
tasks[].connectorOperator.dynatraceenum—Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL…
tasks[].connectorOperator.googleAnalyticsenum—Allowed: PROJECTION, BETWEEN
tasks[].connectorOperator.inforNexusenum—Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL…
tasks[].connectorOperator.marketoenum—Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION…
tasks[].connectorOperator.pardotenum—Allowed: PROJECTION, EQUAL_TO, NO_OP, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL…
tasks[].connectorOperator.s3enum—Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO…
tasks[].connectorOperator.salesforceenum—Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO…
tasks[].connectorOperator.sapoDataenum—Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO…
tasks[].connectorOperator.serviceNowenum—Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO…
tasks[].connectorOperator.singularenum—Allowed: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N…
tasks[].connectorOperator.slackenum—Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL…
tasks[].connectorOperator.trendmicroenum—Allowed: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N…
tasks[].connectorOperator.veevaenum—Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO…
tasks[].connectorOperator.zendeskenum—Allowed: PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N…
tasks[].destinationFieldstring—A field value on which source field should be validated
tasks[].sourceFieldsarray<string>yesSource fields on which particular task will be applied
tasks[].taskPropertiesarray<object>—A Map used to store task related info
tasks[].taskProperties[].keyenumyesAllowed: VALUE, VALUES, DATA_TYPE, UPPER_BOUND, LOWER_BOUND, SOURCE_DATA_TYPE, DESTINATION_DATA_TYPE, VALIDATION_ACTION…
tasks[].taskProperties[].valuestringyes
tasks[].taskTypeenumyesType of task Allowed: Arithmetic, Filter, Map, Map_all, Mask, Merge, Passthrough, Truncate…
triggerConfigobjectyesTrigger settings of the flow.
triggerConfig.triggerPropertiesobject—Details required based on the type of trigger
triggerConfig.triggerProperties.dataPullModeenum—Allowed: Incremental, Complete
triggerConfig.triggerProperties.firstExecutionFromnumber—
triggerConfig.triggerProperties.flowErrorDeactivationThresholdinteger—
triggerConfig.triggerProperties.scheduleEndTimenumber—
triggerConfig.triggerProperties.scheduleExpressionstringyes
triggerConfig.triggerProperties.scheduleOffsetnumber—
triggerConfig.triggerProperties.scheduleStartTimenumber—
triggerConfig.triggerProperties.timeZonestring—
triggerConfig.triggerTypeenumyesTrigger type of the flow Allowed: Scheduled, Event, OnDemand

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
flowArnstring—ARN identifier of the flow.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.