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
| Field | Type | Required | Description |
|---|---|---|---|
connectorLabel | string | — | The name of the connector. |
connectorProvisioningConfig | object | yes | Contains information about the configuration of the connector being registered. |
connectorProvisioningConfig.lambda | object | — | Contains information about the configuration of the lambda which is being registered as the connector. |
connectorProvisioningConfig.lambda.lambdaArn | string | yes | Lambda ARN of the connector being registered. |
connectorProvisioningType | string | yes | The provisioning type of the connector. |
description | string | — | A description about the connector that's being registered. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
connectorArn | string | — | The arn of the connector. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | 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
| Field | Type | Required | Description |
|---|---|---|---|
connectionMode | enum | yes | Mode in which data transfer should be enabled. Allowed: Public, Private |
connectorLabel | string | — | The label of the connector. |
connectorProfileConfig | object | — | Connector specific configurations needed to create connector profile |
connectorProfileConfig.connectorProfileCredentials | object | — | AppFlowConnectorProfileConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.amplitude | object | — | AppFlowConnectorProfileAmplitudeConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.amplitude.apiKey | string | yes | A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. |
connectorProfileConfig.connectorProfileCredentials.amplitude.secretKey | string | yes | |
connectorProfileConfig.connectorProfileCredentials.customConnector | object | — | AppFlowConnectorProfileCustomConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKey | object | — | AppFlowConnectorProfileApiKeyCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKey.apiKey | string | yes | |
connectorProfileConfig.connectorProfileCredentials.customConnector.apiKey.apiSecretKey | string | — | |
connectorProfileConfig.connectorProfileCredentials.customConnector.authenticationType | enum | yes | Allowed: OAUTH2, APIKEY, BASIC, CUSTOM |
connectorProfileConfig.connectorProfileCredentials.customConnector.basic | object | — | AppFlowConnectorProfileBasicAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.basic.password | string | yes | |
connectorProfileConfig.connectorProfileCredentials.customConnector.basic.username | string | yes | |
connectorProfileConfig.connectorProfileCredentials.customConnector.custom | object | — | AppFlowConnectorProfileCustomAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.custom.credentialsMap | map<string> | — | |
connectorProfileConfig.connectorProfileCredentials.customConnector.custom.customAuthenticationType | string | yes | |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2 | object | — | AppFlowConnectorProfileOAuth2Credentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.accessToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.clientId | string | — | |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.clientSecret | string | — | |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequest | object | — | AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.oAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.customConnector.oauth2.refreshToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.datadog | object | — | AppFlowConnectorProfileDatadogConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.datadog.apiKey | string | yes | A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. |
connectorProfileConfig.connectorProfileCredentials.datadog.applicationKey | string | yes | Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. |
connectorProfileConfig.connectorProfileCredentials.dynatrace | object | — | AppFlowConnectorProfileDynatraceConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.dynatrace.apiToken | string | yes | The API tokens used by Dynatrace API to authenticate various API calls. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics | object | — | AppFlowConnectorProfileGoogleAnalyticsConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.clientId | string | yes | The identifier for the desired client. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.clientSecret | string | yes | The client secret used by the oauth client to authenticate to the authorization server. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.googleAnalytics.refreshToken | string | — | The credentials used to acquire new access tokens. |
connectorProfileConfig.connectorProfileCredentials.inforNexus | object | — | AppFlowConnectorProfileInforNexusConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.inforNexus.accessKeyId | string | yes | The Access Key portion of the credentials. |
connectorProfileConfig.connectorProfileCredentials.inforNexus.datakey | string | yes | The encryption keys used to encrypt data. |
connectorProfileConfig.connectorProfileCredentials.inforNexus.secretAccessKey | string | yes | The secret key used to sign requests. |
connectorProfileConfig.connectorProfileCredentials.inforNexus.userId | string | yes | The identifier for the user. |
connectorProfileConfig.connectorProfileCredentials.marketo | object | — | AppFlowConnectorProfileMarketoConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.marketo.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.marketo.clientId | string | yes | The identifier for the desired client. |
connectorProfileConfig.connectorProfileCredentials.marketo.clientSecret | string | yes | The client secret used by the oauth client to authenticate to the authorization server. |
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.marketo.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.pardot | object | — | AppFlowConnectorProfilePardotConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.pardot.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.pardot.clientCredentialsArn | string | — | The client credentials to fetch access token and refresh token. |
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.pardot.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.pardot.refreshToken | string | — | The credentials used to acquire new access tokens. |
connectorProfileConfig.connectorProfileCredentials.redshift | object | — | AppFlowConnectorProfileRedshiftConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.redshift.password | string | — | The password that corresponds to the username. |
connectorProfileConfig.connectorProfileCredentials.redshift.username | string | — | The name of the user. |
connectorProfileConfig.connectorProfileCredentials.salesforce | object | — | AppFlowConnectorProfileSalesforceConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.salesforce.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.salesforce.clientCredentialsArn | string | — | The client credentials to fetch access token and refresh token. |
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.salesforce.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.salesforce.jwtToken | string | — | The credentials used to access your Salesforce records |
connectorProfileConfig.connectorProfileCredentials.salesforce.oAuth2GrantType | enum | — | The grant types to fetch an access token Allowed: CLIENT_CREDENTIALS, AUTHORIZATION_CODE, JWT_BEARER |
connectorProfileConfig.connectorProfileCredentials.salesforce.refreshToken | string | — | The credentials used to acquire new access tokens. |
connectorProfileConfig.connectorProfileCredentials.sapoData | object | — | AppFlowConnectorProfileSAPODataConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentials | object | — | AppFlowConnectorProfileBasicAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentials.password | string | yes | |
connectorProfileConfig.connectorProfileCredentials.sapoData.basicAuthCredentials.username | string | yes | |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials | object | — | AppFlowConnectorProfileSAPODataConnectorProfileCredentialsOAuthCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.accessToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.clientId | string | — | |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.clientSecret | string | — | |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequest | object | — | AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.sapoData.oAuthCredentials.refreshToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.serviceNow | object | — | AppFlowConnectorProfileServiceNowConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials | object | — | The OAuth 2.0 credentials required to authenticate the user. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.accessToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.clientId | string | — | |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.clientSecret | string | — | |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequest | object | — | AppFlowConnectorProfileConnectorOAuthRequest is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.oAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.oAuth2Credentials.refreshToken | string | — | |
connectorProfileConfig.connectorProfileCredentials.serviceNow.password | string | — | The password that corresponds to the username. |
connectorProfileConfig.connectorProfileCredentials.serviceNow.username | string | — | The name of the user. |
connectorProfileConfig.connectorProfileCredentials.singular | object | — | AppFlowConnectorProfileSingularConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.singular.apiKey | string | yes | A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. |
connectorProfileConfig.connectorProfileCredentials.slack | object | — | AppFlowConnectorProfileSlackConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.slack.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.slack.clientId | string | yes | The identifier for the desired client. |
connectorProfileConfig.connectorProfileCredentials.slack.clientSecret | string | yes | The client secret used by the oauth client to authenticate to the authorization server. |
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.slack.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileCredentials.snowflake | object | — | AppFlowConnectorProfileSnowflakeConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.snowflake.password | string | yes | The password that corresponds to the username. |
connectorProfileConfig.connectorProfileCredentials.snowflake.username | string | yes | The name of the user. |
connectorProfileConfig.connectorProfileCredentials.trendmicro | object | — | AppFlowConnectorProfileTrendmicroConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.trendmicro.apiSecretKey | string | yes | The Secret Access Key portion of the credentials. |
connectorProfileConfig.connectorProfileCredentials.veeva | object | — | AppFlowConnectorProfileVeevaConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.veeva.password | string | yes | The password that corresponds to the username. |
connectorProfileConfig.connectorProfileCredentials.veeva.username | string | yes | The name of the user. |
connectorProfileConfig.connectorProfileCredentials.zendesk | object | — | AppFlowConnectorProfileZendeskConnectorProfileCredentials is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileCredentials.zendesk.accessToken | string | — | The credentials used to access protected resources. |
connectorProfileConfig.connectorProfileCredentials.zendesk.clientId | string | yes | The identifier for the desired client. |
connectorProfileConfig.connectorProfileCredentials.zendesk.clientSecret | string | yes | The client secret used by the oauth client to authenticate to the authorization server. |
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequest | object | — | The oauth needed to request security tokens from the connector endpoint. |
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequest.authCode | string | — | The code provided by the connector when it has been authenticated via the connected app. |
connectorProfileConfig.connectorProfileCredentials.zendesk.connectorOAuthRequest.redirectUri | string | — | The URL to which the authentication server redirects the browser after authorization has been granted. |
connectorProfileConfig.connectorProfileProperties | object | — | AppFlowConnectorProfileConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.customConnector | object | — | AppFlowConnectorProfileCustomConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties | object | — | AppFlowConnectorProfileOAuth2Properties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.oAuth2GrantType | enum | — | Allowed: CLIENT_CREDENTIALS, AUTHORIZATION_CODE, JWT_BEARER |
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.tokenUrl | string | — | |
connectorProfileConfig.connectorProfileProperties.customConnector.oAuth2Properties.tokenUrlCustomProperties | map<string> | — | |
connectorProfileConfig.connectorProfileProperties.customConnector.profileProperties | map<string> | — | |
connectorProfileConfig.connectorProfileProperties.datadog | object | — | AppFlowConnectorProfileDatadogConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.datadog.instanceUrl | string | yes | The location of the Datadog resource |
connectorProfileConfig.connectorProfileProperties.dynatrace | object | — | AppFlowConnectorProfileDynatraceConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.dynatrace.instanceUrl | string | yes | The location of the Dynatrace resource |
connectorProfileConfig.connectorProfileProperties.inforNexus | object | — | AppFlowConnectorProfileInforNexusConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.inforNexus.instanceUrl | string | yes | The location of the InforNexus resource |
connectorProfileConfig.connectorProfileProperties.marketo | object | — | AppFlowConnectorProfileMarketoConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.marketo.instanceUrl | string | yes | The location of the Marketo resource |
connectorProfileConfig.connectorProfileProperties.pardot | object | — | AppFlowConnectorProfilePardotConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.pardot.businessUnitId | string | yes | The Business unit id of Salesforce Pardot instance to be connected |
connectorProfileConfig.connectorProfileProperties.pardot.instanceUrl | string | — | The location of the Salesforce Pardot resource |
connectorProfileConfig.connectorProfileProperties.pardot.isSandboxEnvironment | boolean | — | Indicates whether the connector profile applies to a demo or production environment |
connectorProfileConfig.connectorProfileProperties.redshift | object | — | AppFlowConnectorProfileRedshiftConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.redshift.bucketName | string | yes | The name of the Amazon S3 bucket associated with Redshift. |
connectorProfileConfig.connectorProfileProperties.redshift.bucketPrefix | string | — | The object key for the destination bucket in which Amazon AppFlow will place the files. |
connectorProfileConfig.connectorProfileProperties.redshift.clusterIdentifier | string | — | The unique identifier of the Amazon Redshift cluster. |
connectorProfileConfig.connectorProfileProperties.redshift.dataApiRoleArn | string | — | 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.databaseName | string | — | The name of the Amazon Redshift database that will store the transferred data. |
connectorProfileConfig.connectorProfileProperties.redshift.databaseUrl | string | — | The JDBC URL of the Amazon Redshift cluster. |
connectorProfileConfig.connectorProfileProperties.redshift.isRedshiftServerless | boolean | — | If Amazon AppFlow will connect to Amazon Redshift Serverless or Amazon Redshift cluster. |
connectorProfileConfig.connectorProfileProperties.redshift.roleArn | string | yes | The Amazon Resource Name (ARN) of the IAM role. |
connectorProfileConfig.connectorProfileProperties.redshift.workgroupName | string | — | The name of the Amazon Redshift serverless workgroup |
connectorProfileConfig.connectorProfileProperties.salesforce | object | — | AppFlowConnectorProfileSalesforceConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.salesforce.instanceUrl | string | — | The location of the Salesforce resource |
connectorProfileConfig.connectorProfileProperties.salesforce.isSandboxEnvironment | boolean | — | Indicates whether the connector profile applies to a sandbox or production environment |
connectorProfileConfig.connectorProfileProperties.salesforce.usePrivateLinkForMetadataAndAuthorization | boolean | — | Indicates whether to make Metadata And Authorization calls over Pivate Network |
connectorProfileConfig.connectorProfileProperties.sapoData | object | — | AppFlowConnectorProfileSAPODataConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.sapoData.applicationHostUrl | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.applicationServicePath | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.clientNumber | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.disableSSO | boolean | — | 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.logonLanguage | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties | object | — | AppFlowConnectorProfileOAuthProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.authCodeUrl | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.oAuthScopes | array<string> | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.oAuthProperties.tokenUrl | string | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.portNumber | integer | — | |
connectorProfileConfig.connectorProfileProperties.sapoData.privateLinkServiceName | string | — | |
connectorProfileConfig.connectorProfileProperties.serviceNow | object | — | AppFlowConnectorProfileServiceNowConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.serviceNow.instanceUrl | string | yes | The location of the ServiceNow resource |
connectorProfileConfig.connectorProfileProperties.slack | object | — | AppFlowConnectorProfileSlackConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.slack.instanceUrl | string | yes | The location of the Slack resource |
connectorProfileConfig.connectorProfileProperties.snowflake | object | — | AppFlowConnectorProfileSnowflakeConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.snowflake.accountName | string | — | The name of the account. |
connectorProfileConfig.connectorProfileProperties.snowflake.bucketName | string | yes | The name of the Amazon S3 bucket associated with Snowflake. |
connectorProfileConfig.connectorProfileProperties.snowflake.bucketPrefix | string | — | The bucket prefix that refers to the Amazon S3 bucket associated with Snowflake. |
connectorProfileConfig.connectorProfileProperties.snowflake.privateLinkServiceName | string | — | The Snowflake Private Link service name to be used for private data transfers. |
connectorProfileConfig.connectorProfileProperties.snowflake.region | string | — | The region of the Snowflake account. |
connectorProfileConfig.connectorProfileProperties.snowflake.stage | string | yes | The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. |
connectorProfileConfig.connectorProfileProperties.snowflake.warehouse | string | yes | The name of the Snowflake warehouse. |
connectorProfileConfig.connectorProfileProperties.veeva | object | — | AppFlowConnectorProfileVeevaConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.veeva.instanceUrl | string | yes | The location of the Veeva resource |
connectorProfileConfig.connectorProfileProperties.zendesk | object | — | AppFlowConnectorProfileZendeskConnectorProfileProperties is a nested property type of AWS::AppFlow::ConnectorProfile. |
connectorProfileConfig.connectorProfileProperties.zendesk.instanceUrl | string | yes | The location of the Zendesk resource |
connectorProfileName | string | yes | The maximum number of items to retrieve in a single batch. |
connectorType | enum | yes | List 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… |
kmsArn | string | — | The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
connectorProfileArn | string | — | Unique identifier for connector profile resources Read-only: reported by AWS after creation. |
credentialsArn | string | — | A unique Arn for Connector-Profile resource Read-only: reported by AWS after creation. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | 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
| Field | Type | Required | Description |
|---|---|---|---|
description | string | — | Description of the flow. |
destinationFlowConfigList | array<object> | yes | List of Destination connectors of the flow. |
destinationFlowConfigList[].apiVersion | string | — | The API version that the destination connector uses. |
destinationFlowConfigList[].connectorProfileName | string | — | Name of destination connector profile |
destinationFlowConfigList[].connectorType | enum | yes | Destination connector type Allowed: SAPOData, Salesforce, Pardot, Singular, Slack, Redshift, S3, Marketo… |
destinationFlowConfigList[].destinationConnectorProperties | object | yes | Destination connector details |
destinationFlowConfigList[].destinationConnectorProperties.customConnector | object | — | AppFlowFlowCustomConnectorDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.customProperties | map<string> | — | |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.entityName | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.idFieldNames | array<string> | — | List of fields used as ID when performing a write operation. |
destinationFlowConfigList[].destinationConnectorProperties.customConnector.writeOperationType | enum | — | Allowed: INSERT, UPSERT, UPDATE, DELETE |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge | object | — | AppFlowFlowEventBridgeDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.eventBridge.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.lookoutMetrics | object | — | AppFlowFlowLookoutMetricsDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.lookoutMetrics.object | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.marketo | object | — | AppFlowFlowMarketoDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.marketo.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.marketo.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.redshift | object | — | AppFlowFlowRedshiftDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.redshift.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.redshift.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.redshift.intermediateBucketName | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.redshift.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.s3 | object | — | AppFlowFlowS3DestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.s3.bucketName | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.s3.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig | object | — | AppFlowFlowS3OutputFormatConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfig | object | — | AppFlowFlowAggregationConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfig.aggregationType | enum | — | Allowed: None, SingleFile |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.aggregationConfig.targetFileSize | integer | — | |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.fileType | enum | — | Allowed: CSV, JSON, PARQUET |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig | object | — | AppFlowFlowPrefixConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.pathPrefixHierarchy | array<string> | — | |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.prefixFormat | enum | — | Allowed: YEAR, MONTH, DAY, HOUR, MINUTE |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.prefixConfig.prefixType | enum | — | Allowed: FILENAME, PATH, PATH_AND_FILENAME |
destinationFlowConfigList[].destinationConnectorProperties.s3.s3OutputFormatConfig.preserveSourceDataTyping | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.salesforce | object | — | AppFlowFlowSalesforceDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.dataTransferApi | enum | — | Allowed: AUTOMATIC, BULKV2, REST_SYNC |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.idFieldNames | array<string> | — | List of fields used as ID when performing a write operation. |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.salesforce.writeOperationType | enum | — | Allowed: INSERT, UPSERT, UPDATE, DELETE |
destinationFlowConfigList[].destinationConnectorProperties.sapoData | object | — | AppFlowFlowSAPODataDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.idFieldNames | array<string> | — | List of fields used as ID when performing a write operation. |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.objectPath | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfig | object | — | AppFlowFlowSuccessResponseHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.successResponseHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.sapoData.writeOperationType | enum | — | Allowed: INSERT, UPSERT, UPDATE, DELETE |
destinationFlowConfigList[].destinationConnectorProperties.snowflake | object | — | AppFlowFlowSnowflakeDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.intermediateBucketName | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.snowflake.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.upsolver | object | — | AppFlowFlowUpsolverDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.bucketName | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig | object | yes | AppFlowFlowUpsolverS3OutputFormatConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfig | object | — | AppFlowFlowAggregationConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfig.aggregationType | enum | — | Allowed: None, SingleFile |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.aggregationConfig.targetFileSize | integer | — | |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.fileType | enum | — | Allowed: CSV, JSON, PARQUET |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig | object | yes | AppFlowFlowPrefixConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.pathPrefixHierarchy | array<string> | — | |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.prefixFormat | enum | — | Allowed: YEAR, MONTH, DAY, HOUR, MINUTE |
destinationFlowConfigList[].destinationConnectorProperties.upsolver.s3OutputFormatConfig.prefixConfig.prefixType | enum | — | Allowed: FILENAME, PATH, PATH_AND_FILENAME |
destinationFlowConfigList[].destinationConnectorProperties.zendesk | object | — | AppFlowFlowZendeskDestinationProperties is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig | object | — | AppFlowFlowErrorHandlingConfig is a nested property type of AWS::AppFlow::Flow. |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.bucketName | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.bucketPrefix | string | — | |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.errorHandlingConfig.failOnFirstError | boolean | — | |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.idFieldNames | array<string> | — | List of fields used as ID when performing a write operation. |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.object | string | yes | |
destinationFlowConfigList[].destinationConnectorProperties.zendesk.writeOperationType | enum | — | Allowed: INSERT, UPSERT, UPDATE, DELETE |
flowName | string | yes | Name of the flow. |
flowStatus | enum | — | Flow activation status for Scheduled- and Event-triggered flows Allowed: Active, Suspended, Draft |
kmsArn | string | — | The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. |
metadataCatalogConfig | object | — | Configurations of metadata catalog of the flow. |
metadataCatalogConfig.glueDataCatalog | object | — | Configurations of glue data catalog of the flow. |
metadataCatalogConfig.glueDataCatalog.databaseName | string | yes | A string containing the value for the tag |
metadataCatalogConfig.glueDataCatalog.roleArn | string | yes | A string containing the value for the tag |
metadataCatalogConfig.glueDataCatalog.tablePrefix | string | yes | A string containing the value for the tag |
providerRef | object | — | ProviderRef selects the AWSProvider (account/region) this resource is reconciled against. |
providerRef.name | string | yes | Name of a cluster-scoped AWSProvider. |
providerRef.region | string | — | Region overrides the provider's region for this resource only. |
sourceFlowConfig | object | yes | Configurations of Source connector of the flow. |
sourceFlowConfig.apiVersion | string | — | The API version that the destination connector uses. |
sourceFlowConfig.connectorProfileName | string | — | Name of source connector profile |
sourceFlowConfig.connectorType | enum | yes | Type of source connector Allowed: SAPOData, Salesforce, Pardot, Singular, Slack, Redshift, S3, Marketo… |
sourceFlowConfig.incrementalPullConfig | object | — | Configuration for scheduled incremental data pull |
sourceFlowConfig.incrementalPullConfig.datetimeTypeFieldName | string | — | |
sourceFlowConfig.sourceConnectorProperties | object | yes | Source connector details required to query a connector |
sourceFlowConfig.sourceConnectorProperties.amplitude | object | — | AppFlowFlowAmplitudeSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.amplitude.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.customConnector | object | — | AppFlowFlowCustomConnectorSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.customConnector.customProperties | map<string> | — | |
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApi | object | — | AppFlowFlowCustomConnectorSourcePropertiesDataTransferApi is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApi.name | string | yes | |
sourceFlowConfig.sourceConnectorProperties.customConnector.dataTransferApi.type | enum | yes | Allowed: SYNC, ASYNC, AUTOMATIC |
sourceFlowConfig.sourceConnectorProperties.customConnector.entityName | string | yes | |
sourceFlowConfig.sourceConnectorProperties.datadog | object | — | AppFlowFlowDatadogSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.datadog.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.dynatrace | object | — | AppFlowFlowDynatraceSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.dynatrace.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.googleAnalytics | object | — | AppFlowFlowGoogleAnalyticsSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.googleAnalytics.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.inforNexus | object | — | AppFlowFlowInforNexusSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.inforNexus.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.marketo | object | — | AppFlowFlowMarketoSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.marketo.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.pardot | object | — | AppFlowFlowPardotSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.pardot.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.s3 | object | — | AppFlowFlowS3SourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.s3.bucketName | string | yes | |
sourceFlowConfig.sourceConnectorProperties.s3.bucketPrefix | string | yes | |
sourceFlowConfig.sourceConnectorProperties.s3.s3InputFormatConfig | object | — | AppFlowFlowS3InputFormatConfig is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.s3.s3InputFormatConfig.s3InputFileType | enum | — | Allowed: CSV, JSON |
sourceFlowConfig.sourceConnectorProperties.salesforce | object | — | AppFlowFlowSalesforceSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.salesforce.dataTransferApi | enum | — | Allowed: AUTOMATIC, BULKV2, REST_SYNC |
sourceFlowConfig.sourceConnectorProperties.salesforce.enableDynamicFieldUpdate | boolean | — | |
sourceFlowConfig.sourceConnectorProperties.salesforce.includeDeletedRecords | boolean | — | |
sourceFlowConfig.sourceConnectorProperties.salesforce.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.sapoData | object | — | AppFlowFlowSAPODataSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.sapoData.objectPath | string | yes | |
sourceFlowConfig.sourceConnectorProperties.sapoData.paginationConfig | object | — | AppFlowFlowSAPODataPaginationConfig is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.sapoData.paginationConfig.maxPageSize | integer | yes | |
sourceFlowConfig.sourceConnectorProperties.sapoData.parallelismConfig | object | — | AppFlowFlowSAPODataParallelismConfig is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.sapoData.parallelismConfig.maxParallelism | integer | yes | |
sourceFlowConfig.sourceConnectorProperties.serviceNow | object | — | AppFlowFlowServiceNowSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.serviceNow.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.singular | object | — | AppFlowFlowSingularSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.singular.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.slack | object | — | AppFlowFlowSlackSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.slack.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.trendmicro | object | — | AppFlowFlowTrendmicroSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.trendmicro.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.veeva | object | — | AppFlowFlowVeevaSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.veeva.documentType | string | — | |
sourceFlowConfig.sourceConnectorProperties.veeva.includeAllVersions | boolean | — | |
sourceFlowConfig.sourceConnectorProperties.veeva.includeRenditions | boolean | — | |
sourceFlowConfig.sourceConnectorProperties.veeva.includeSourceFiles | boolean | — | |
sourceFlowConfig.sourceConnectorProperties.veeva.object | string | yes | |
sourceFlowConfig.sourceConnectorProperties.zendesk | object | — | AppFlowFlowZendeskSourceProperties is a nested property type of AWS::AppFlow::Flow. |
sourceFlowConfig.sourceConnectorProperties.zendesk.object | string | yes | |
tags | array<object> | — | List of Tags. |
tags[].key | string | yes | |
tags[].value | string | yes | |
tasks | array<object> | yes | List of tasks for the flow. |
tasks[].connectorOperator | object | — | Operation to be performed on provided source fields |
tasks[].connectorOperator.amplitude | enum | — | Allowed: BETWEEN |
tasks[].connectorOperator.customConnector | enum | — | Allowed: PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO… |
tasks[].connectorOperator.datadog | enum | — | Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL… |
tasks[].connectorOperator.dynatrace | enum | — | Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL… |
tasks[].connectorOperator.googleAnalytics | enum | — | Allowed: PROJECTION, BETWEEN |
tasks[].connectorOperator.inforNexus | enum | — | Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL… |
tasks[].connectorOperator.marketo | enum | — | Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION… |
tasks[].connectorOperator.pardot | enum | — | Allowed: PROJECTION, EQUAL_TO, NO_OP, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL… |
tasks[].connectorOperator.s3 | enum | — | Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO… |
tasks[].connectorOperator.salesforce | enum | — | Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO… |
tasks[].connectorOperator.sapoData | enum | — | Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO… |
tasks[].connectorOperator.serviceNow | enum | — | Allowed: PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO… |
tasks[].connectorOperator.singular | enum | — | Allowed: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N… |
tasks[].connectorOperator.slack | enum | — | Allowed: PROJECTION, BETWEEN, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL… |
tasks[].connectorOperator.trendmicro | enum | — | Allowed: PROJECTION, EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N… |
tasks[].connectorOperator.veeva | enum | — | Allowed: PROJECTION, LESS_THAN, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO… |
tasks[].connectorOperator.zendesk | enum | — | Allowed: PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N… |
tasks[].destinationField | string | — | A field value on which source field should be validated |
tasks[].sourceFields | array<string> | yes | Source fields on which particular task will be applied |
tasks[].taskProperties | array<object> | — | A Map used to store task related info |
tasks[].taskProperties[].key | enum | yes | Allowed: VALUE, VALUES, DATA_TYPE, UPPER_BOUND, LOWER_BOUND, SOURCE_DATA_TYPE, DESTINATION_DATA_TYPE, VALIDATION_ACTION… |
tasks[].taskProperties[].value | string | yes | |
tasks[].taskType | enum | yes | Type of task Allowed: Arithmetic, Filter, Map, Map_all, Mask, Merge, Passthrough, Truncate… |
triggerConfig | object | yes | Trigger settings of the flow. |
triggerConfig.triggerProperties | object | — | Details required based on the type of trigger |
triggerConfig.triggerProperties.dataPullMode | enum | — | Allowed: Incremental, Complete |
triggerConfig.triggerProperties.firstExecutionFrom | number | — | |
triggerConfig.triggerProperties.flowErrorDeactivationThreshold | integer | — | |
triggerConfig.triggerProperties.scheduleEndTime | number | — | |
triggerConfig.triggerProperties.scheduleExpression | string | yes | |
triggerConfig.triggerProperties.scheduleOffset | number | — | |
triggerConfig.triggerProperties.scheduleStartTime | number | — | |
triggerConfig.triggerProperties.timeZone | string | — | |
triggerConfig.triggerType | enum | yes | Trigger type of the flow Allowed: Scheduled, Event, OnDemand |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
awsProvider | object | — | AWSProvider confirms the account and region this resource was reconciled against. |
awsProvider.accountId | string | — | AccountID the resource lives in. |
awsProvider.name | string | — | Name of the AWSProvider used; empty when the operator's own credentials were used. |
awsProvider.region | string | — | Region the resource lives in (empty for global services). |
conditions | array<object> | — | Conditions describe the current state of the resource. |
conditions[].lastTransitionTime | string | yes | lastTransitionTime is the last time the condition transitioned from one status to another. |
conditions[].message | string | yes | message is a human readable message indicating details about the transition. |
conditions[].observedGeneration | integer | — | observedGeneration represents the .metadata.generation that the condition was set based upon. |
conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. |
conditions[].status | enum | yes | status of the condition, one of True, False, Unknown. Allowed: True, False, Unknown |
conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. |
flowArn | string | — | ARN identifier of the flow. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |