This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon AppFlow **Resource types** + [AWS::AppFlow::Connector](aws-resource-appflow-connector.md) + [AWS::AppFlow::ConnectorProfile](aws-resource-appflow-connectorprofile.md) + [AWS::AppFlow::Flow](aws-resource-appflow-flow.md) # AWS::AppFlow::Connector Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. In each connector profile that you create, you can provide the credentials and properties for only one connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::AppFlow::Connector", "Properties" : { "[ConnectorLabel](#cfn-appflow-connector-connectorlabel)" : String, "[ConnectorProvisioningConfig](#cfn-appflow-connector-connectorprovisioningconfig)" : ConnectorProvisioningConfig, "[ConnectorProvisioningType](#cfn-appflow-connector-connectorprovisioningtype)" : String, "[Description](#cfn-appflow-connector-description)" : String } } ``` ### YAML ``` Type: AWS::AppFlow::Connector Properties: [ConnectorLabel](#cfn-appflow-connector-connectorlabel): String [ConnectorProvisioningConfig](#cfn-appflow-connector-connectorprovisioningconfig): ConnectorProvisioningConfig [ConnectorProvisioningType](#cfn-appflow-connector-connectorprovisioningtype): String [Description](#cfn-appflow-connector-description): String ``` ## Properties `ConnectorLabel` The label used for registering the connector. *Required*: No *Type*: String *Pattern*: `[a-zA-Z0-9][\w!@#.-]+` *Maximum*: `512` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ConnectorProvisioningConfig` The configuration required for registering the connector. *Required*: Yes *Type*: [ConnectorProvisioningConfig](aws-properties-appflow-connector-connectorprovisioningconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorProvisioningType` The provisioning type used to register the connector. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9][\w!@#.-]+` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description about the connector runtime setting. *Required*: No *Type*: String *Pattern*: `[\s\w/!@#+=.-]*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `ConnectorArn` Property description not available. # AWS::AppFlow::Connector ConnectorProvisioningConfig Contains information about the configuration of the connector being registered. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Lambda](#cfn-appflow-connector-connectorprovisioningconfig-lambda)" : LambdaConnectorProvisioningConfig } ``` ### YAML ``` [Lambda](#cfn-appflow-connector-connectorprovisioningconfig-lambda): LambdaConnectorProvisioningConfig ``` ## Properties `Lambda` Contains information about the configuration of the lambda which is being registered as the connector. *Required*: No *Type*: [LambdaConnectorProvisioningConfig](aws-properties-appflow-connector-lambdaconnectorprovisioningconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Connector LambdaConnectorProvisioningConfig Contains information about the configuration of the lambda which is being registered as the connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LambdaArn](#cfn-appflow-connector-lambdaconnectorprovisioningconfig-lambdaarn)" : String } ``` ### YAML ``` [LambdaArn](#cfn-appflow-connector-lambdaconnectorprovisioningconfig-lambdaarn): String ``` ## Properties `LambdaArn` Lambda ARN of the connector being registered. *Required*: Yes *Type*: String *Pattern*: `arn:*:.*:.*:[0-9]+:.*` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile The `AWS::AppFlow::ConnectorProfile` resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. The fields that are common to all types of connector profiles are explicitly specified under the `Properties` field. The rest of the connector-specific properties are specified under `Properties/ConnectorProfileConfig`. **Note** If you want to use CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::AppFlow::ConnectorProfile", "Properties" : { "[ConnectionMode](#cfn-appflow-connectorprofile-connectionmode)" : String, "[ConnectorLabel](#cfn-appflow-connectorprofile-connectorlabel)" : String, "[ConnectorProfileConfig](#cfn-appflow-connectorprofile-connectorprofileconfig)" : ConnectorProfileConfig, "[ConnectorProfileName](#cfn-appflow-connectorprofile-connectorprofilename)" : String, "[ConnectorType](#cfn-appflow-connectorprofile-connectortype)" : String, "[KMSArn](#cfn-appflow-connectorprofile-kmsarn)" : String } } ``` ### YAML ``` Type: AWS::AppFlow::ConnectorProfile Properties: [ConnectionMode](#cfn-appflow-connectorprofile-connectionmode): String [ConnectorLabel](#cfn-appflow-connectorprofile-connectorlabel): String [ConnectorProfileConfig](#cfn-appflow-connectorprofile-connectorprofileconfig): ConnectorProfileConfig [ConnectorProfileName](#cfn-appflow-connectorprofile-connectorprofilename): String [ConnectorType](#cfn-appflow-connectorprofile-connectortype): String [KMSArn](#cfn-appflow-connectorprofile-kmsarn): String ``` ## Properties `ConnectionMode` Indicates the connection mode and if it is public or private. *Required*: Yes *Type*: String *Allowed values*: `Public | Private` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorLabel` The label for the connector profile being created. *Required*: No *Type*: String *Pattern*: `[\w!@#.-]+` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ConnectorProfileConfig` Defines the connector-specific configuration and credentials. *Required*: No *Type*: [ConnectorProfileConfig](aws-properties-appflow-connectorprofile-connectorprofileconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorProfileName` The name of the connector profile. The name is unique for each `ConnectorProfile` in the AWS account. *Required*: Yes *Type*: String *Pattern*: `[\w/!@#+=.-]+` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ConnectorType` The type of connector, such as Salesforce, Amplitude, and so on. *Required*: Yes *Type*: String *Allowed values*: `Salesforce | Pardot | Singular | Slack | Redshift | Marketo | Googleanalytics | Zendesk | Servicenow | SAPOData | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | CustomConnector` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KMSArn` The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. *Required*: No *Type*: String *Pattern*: `arn:aws:kms:.*:[0-9]+:.*` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the connector profile name. For example: `{ "Ref": "myConnectorProfile" }` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `ConnectorProfileArn` The Amazon Resource Name (ARN) of the connector profile. `CredentialsArn` The Amazon Resource Name (ARN) of the connector profile credentials. ## See also + [CreateConnectorProfile](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_CreateConnectorProfile.html) in the *Amazon AppFlow API Reference*. + [DescribeConnectorProfiles](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DescribeConnectorProfiles.html) in the *Amazon AppFlow API Reference*. + [DeleteConnectorProfile](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DeleteConnectorProfile.html) in the *Amazon AppFlow API Reference*. + [UpdateConnectorProfile](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_UpdateConnectorProfile.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile AmplitudeConnectorProfileCredentials The connector-specific credentials required when using Amplitude. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiKey](#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-apikey)" : String, "[SecretKey](#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-secretkey)" : String } ``` ### YAML ``` [ApiKey](#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-apikey): String [SecretKey](#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-secretkey): String ``` ## Properties `ApiKey` A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretKey` The Secret Access Key portion of the credentials. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [AmplitudeConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_AmplitudeConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ApiKeyCredentials The API key credentials required for API key authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiKey](#cfn-appflow-connectorprofile-apikeycredentials-apikey)" : String, "[ApiSecretKey](#cfn-appflow-connectorprofile-apikeycredentials-apisecretkey)" : String } ``` ### YAML ``` [ApiKey](#cfn-appflow-connectorprofile-apikeycredentials-apikey): String [ApiSecretKey](#cfn-appflow-connectorprofile-apikeycredentials-apisecretkey): String ``` ## Properties `ApiKey` The API key required for API key authentication. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApiSecretKey` The API secret key required for API key authentication. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile BasicAuthCredentials The basic auth credentials required for basic authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-appflow-connectorprofile-basicauthcredentials-password)" : String, "[Username](#cfn-appflow-connectorprofile-basicauthcredentials-username)" : String } ``` ### YAML ``` [Password](#cfn-appflow-connectorprofile-basicauthcredentials-password): String [Username](#cfn-appflow-connectorprofile-basicauthcredentials-username): String ``` ## Properties `Password` The password to use to connect to a resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The username to use to connect to a resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile ConnectorOAuthRequest Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthCode](#cfn-appflow-connectorprofile-connectoroauthrequest-authcode)" : String, "[RedirectUri](#cfn-appflow-connectorprofile-connectoroauthrequest-redirecturi)" : String } ``` ### YAML ``` [AuthCode](#cfn-appflow-connectorprofile-connectoroauthrequest-authcode): String [RedirectUri](#cfn-appflow-connectorprofile-connectoroauthrequest-redirecturi): String ``` ## Properties `AuthCode` The code provided by the connector when it has been authenticated via the connected app. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedirectUri` The URL to which the authentication server redirects the browser after authorization has been granted. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ConnectorOAuthRequest](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ConnectorOAuthRequest.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ConnectorProfileConfig Defines the connector-specific configuration and credentials for the connector profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConnectorProfileCredentials](#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofilecredentials)" : ConnectorProfileCredentials, "[ConnectorProfileProperties](#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofileproperties)" : ConnectorProfileProperties } ``` ### YAML ``` [ConnectorProfileCredentials](#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofilecredentials): ConnectorProfileCredentials [ConnectorProfileProperties](#cfn-appflow-connectorprofile-connectorprofileconfig-connectorprofileproperties): ConnectorProfileProperties ``` ## Properties `ConnectorProfileCredentials` The connector-specific credentials required by each connector. *Required*: No *Type*: [ConnectorProfileCredentials](aws-properties-appflow-connectorprofile-connectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorProfileProperties` The connector-specific properties of the profile configuration. *Required*: No *Type*: [ConnectorProfileProperties](aws-properties-appflow-connectorprofile-connectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ConnectorProfileConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ConnectorProfileConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ConnectorProfileCredentials The connector-specific credentials required by a connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Amplitude](#cfn-appflow-connectorprofile-connectorprofilecredentials-amplitude)" : AmplitudeConnectorProfileCredentials, "[CustomConnector](#cfn-appflow-connectorprofile-connectorprofilecredentials-customconnector)" : CustomConnectorProfileCredentials, "[Datadog](#cfn-appflow-connectorprofile-connectorprofilecredentials-datadog)" : DatadogConnectorProfileCredentials, "[Dynatrace](#cfn-appflow-connectorprofile-connectorprofilecredentials-dynatrace)" : DynatraceConnectorProfileCredentials, "[GoogleAnalytics](#cfn-appflow-connectorprofile-connectorprofilecredentials-googleanalytics)" : GoogleAnalyticsConnectorProfileCredentials, "[InforNexus](#cfn-appflow-connectorprofile-connectorprofilecredentials-infornexus)" : InforNexusConnectorProfileCredentials, "[Marketo](#cfn-appflow-connectorprofile-connectorprofilecredentials-marketo)" : MarketoConnectorProfileCredentials, "[Pardot](#cfn-appflow-connectorprofile-connectorprofilecredentials-pardot)" : PardotConnectorProfileCredentials, "[Redshift](#cfn-appflow-connectorprofile-connectorprofilecredentials-redshift)" : RedshiftConnectorProfileCredentials, "[Salesforce](#cfn-appflow-connectorprofile-connectorprofilecredentials-salesforce)" : SalesforceConnectorProfileCredentials, "[SAPOData](#cfn-appflow-connectorprofile-connectorprofilecredentials-sapodata)" : SAPODataConnectorProfileCredentials, "[ServiceNow](#cfn-appflow-connectorprofile-connectorprofilecredentials-servicenow)" : ServiceNowConnectorProfileCredentials, "[Singular](#cfn-appflow-connectorprofile-connectorprofilecredentials-singular)" : SingularConnectorProfileCredentials, "[Slack](#cfn-appflow-connectorprofile-connectorprofilecredentials-slack)" : SlackConnectorProfileCredentials, "[Snowflake](#cfn-appflow-connectorprofile-connectorprofilecredentials-snowflake)" : SnowflakeConnectorProfileCredentials, "[Trendmicro](#cfn-appflow-connectorprofile-connectorprofilecredentials-trendmicro)" : TrendmicroConnectorProfileCredentials, "[Veeva](#cfn-appflow-connectorprofile-connectorprofilecredentials-veeva)" : VeevaConnectorProfileCredentials, "[Zendesk](#cfn-appflow-connectorprofile-connectorprofilecredentials-zendesk)" : ZendeskConnectorProfileCredentials } ``` ### YAML ``` [Amplitude](#cfn-appflow-connectorprofile-connectorprofilecredentials-amplitude): AmplitudeConnectorProfileCredentials [CustomConnector](#cfn-appflow-connectorprofile-connectorprofilecredentials-customconnector): CustomConnectorProfileCredentials [Datadog](#cfn-appflow-connectorprofile-connectorprofilecredentials-datadog): DatadogConnectorProfileCredentials [Dynatrace](#cfn-appflow-connectorprofile-connectorprofilecredentials-dynatrace): DynatraceConnectorProfileCredentials [GoogleAnalytics](#cfn-appflow-connectorprofile-connectorprofilecredentials-googleanalytics): GoogleAnalyticsConnectorProfileCredentials [InforNexus](#cfn-appflow-connectorprofile-connectorprofilecredentials-infornexus): InforNexusConnectorProfileCredentials [Marketo](#cfn-appflow-connectorprofile-connectorprofilecredentials-marketo): MarketoConnectorProfileCredentials [Pardot](#cfn-appflow-connectorprofile-connectorprofilecredentials-pardot): PardotConnectorProfileCredentials [Redshift](#cfn-appflow-connectorprofile-connectorprofilecredentials-redshift): RedshiftConnectorProfileCredentials [Salesforce](#cfn-appflow-connectorprofile-connectorprofilecredentials-salesforce): SalesforceConnectorProfileCredentials [SAPOData](#cfn-appflow-connectorprofile-connectorprofilecredentials-sapodata): SAPODataConnectorProfileCredentials [ServiceNow](#cfn-appflow-connectorprofile-connectorprofilecredentials-servicenow): ServiceNowConnectorProfileCredentials [Singular](#cfn-appflow-connectorprofile-connectorprofilecredentials-singular): SingularConnectorProfileCredentials [Slack](#cfn-appflow-connectorprofile-connectorprofilecredentials-slack): SlackConnectorProfileCredentials [Snowflake](#cfn-appflow-connectorprofile-connectorprofilecredentials-snowflake): SnowflakeConnectorProfileCredentials [Trendmicro](#cfn-appflow-connectorprofile-connectorprofilecredentials-trendmicro): TrendmicroConnectorProfileCredentials [Veeva](#cfn-appflow-connectorprofile-connectorprofilecredentials-veeva): VeevaConnectorProfileCredentials [Zendesk](#cfn-appflow-connectorprofile-connectorprofilecredentials-zendesk): ZendeskConnectorProfileCredentials ``` ## Properties `Amplitude` The connector-specific credentials required when using Amplitude. *Required*: No *Type*: [AmplitudeConnectorProfileCredentials](aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomConnector` The connector-specific profile credentials that are required when using the custom connector. *Required*: No *Type*: [CustomConnectorProfileCredentials](aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Datadog` The connector-specific credentials required when using Datadog. *Required*: No *Type*: [DatadogConnectorProfileCredentials](aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Dynatrace` The connector-specific credentials required when using Dynatrace. *Required*: No *Type*: [DynatraceConnectorProfileCredentials](aws-properties-appflow-connectorprofile-dynatraceconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GoogleAnalytics` The connector-specific credentials required when using Google Analytics. *Required*: No *Type*: [GoogleAnalyticsConnectorProfileCredentials](aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InforNexus` The connector-specific credentials required when using Infor Nexus. *Required*: No *Type*: [InforNexusConnectorProfileCredentials](aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Marketo` The connector-specific credentials required when using Marketo. *Required*: No *Type*: [MarketoConnectorProfileCredentials](aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pardot` The connector-specific credentials required when using Salesforce Pardot. *Required*: No *Type*: [PardotConnectorProfileCredentials](aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Redshift` The connector-specific credentials required when using Amazon Redshift. *Required*: No *Type*: [RedshiftConnectorProfileCredentials](aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The connector-specific credentials required when using Salesforce. *Required*: No *Type*: [SalesforceConnectorProfileCredentials](aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPOData` The connector-specific profile credentials required when using SAPOData. *Required*: No *Type*: [SAPODataConnectorProfileCredentials](aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` The connector-specific credentials required when using ServiceNow. *Required*: No *Type*: [ServiceNowConnectorProfileCredentials](aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Singular` The connector-specific credentials required when using Singular. *Required*: No *Type*: [SingularConnectorProfileCredentials](aws-properties-appflow-connectorprofile-singularconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slack` The connector-specific credentials required when using Slack. *Required*: No *Type*: [SlackConnectorProfileCredentials](aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Snowflake` The connector-specific credentials required when using Snowflake. *Required*: No *Type*: [SnowflakeConnectorProfileCredentials](aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Trendmicro` The connector-specific credentials required when using Trend Micro. *Required*: No *Type*: [TrendmicroConnectorProfileCredentials](aws-properties-appflow-connectorprofile-trendmicroconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Veeva` The connector-specific credentials required when using Veeva. *Required*: No *Type*: [VeevaConnectorProfileCredentials](aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The connector-specific credentials required when using Zendesk. *Required*: No *Type*: [ZendeskConnectorProfileCredentials](aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ConnectorProfileProperties The connector-specific profile properties required by each connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomConnector](#cfn-appflow-connectorprofile-connectorprofileproperties-customconnector)" : CustomConnectorProfileProperties, "[Datadog](#cfn-appflow-connectorprofile-connectorprofileproperties-datadog)" : DatadogConnectorProfileProperties, "[Dynatrace](#cfn-appflow-connectorprofile-connectorprofileproperties-dynatrace)" : DynatraceConnectorProfileProperties, "[InforNexus](#cfn-appflow-connectorprofile-connectorprofileproperties-infornexus)" : InforNexusConnectorProfileProperties, "[Marketo](#cfn-appflow-connectorprofile-connectorprofileproperties-marketo)" : MarketoConnectorProfileProperties, "[Pardot](#cfn-appflow-connectorprofile-connectorprofileproperties-pardot)" : PardotConnectorProfileProperties, "[Redshift](#cfn-appflow-connectorprofile-connectorprofileproperties-redshift)" : RedshiftConnectorProfileProperties, "[Salesforce](#cfn-appflow-connectorprofile-connectorprofileproperties-salesforce)" : SalesforceConnectorProfileProperties, "[SAPOData](#cfn-appflow-connectorprofile-connectorprofileproperties-sapodata)" : SAPODataConnectorProfileProperties, "[ServiceNow](#cfn-appflow-connectorprofile-connectorprofileproperties-servicenow)" : ServiceNowConnectorProfileProperties, "[Slack](#cfn-appflow-connectorprofile-connectorprofileproperties-slack)" : SlackConnectorProfileProperties, "[Snowflake](#cfn-appflow-connectorprofile-connectorprofileproperties-snowflake)" : SnowflakeConnectorProfileProperties, "[Veeva](#cfn-appflow-connectorprofile-connectorprofileproperties-veeva)" : VeevaConnectorProfileProperties, "[Zendesk](#cfn-appflow-connectorprofile-connectorprofileproperties-zendesk)" : ZendeskConnectorProfileProperties } ``` ### YAML ``` [CustomConnector](#cfn-appflow-connectorprofile-connectorprofileproperties-customconnector): CustomConnectorProfileProperties [Datadog](#cfn-appflow-connectorprofile-connectorprofileproperties-datadog): DatadogConnectorProfileProperties [Dynatrace](#cfn-appflow-connectorprofile-connectorprofileproperties-dynatrace): DynatraceConnectorProfileProperties [InforNexus](#cfn-appflow-connectorprofile-connectorprofileproperties-infornexus): InforNexusConnectorProfileProperties [Marketo](#cfn-appflow-connectorprofile-connectorprofileproperties-marketo): MarketoConnectorProfileProperties [Pardot](#cfn-appflow-connectorprofile-connectorprofileproperties-pardot): PardotConnectorProfileProperties [Redshift](#cfn-appflow-connectorprofile-connectorprofileproperties-redshift): RedshiftConnectorProfileProperties [Salesforce](#cfn-appflow-connectorprofile-connectorprofileproperties-salesforce): SalesforceConnectorProfileProperties [SAPOData](#cfn-appflow-connectorprofile-connectorprofileproperties-sapodata): SAPODataConnectorProfileProperties [ServiceNow](#cfn-appflow-connectorprofile-connectorprofileproperties-servicenow): ServiceNowConnectorProfileProperties [Slack](#cfn-appflow-connectorprofile-connectorprofileproperties-slack): SlackConnectorProfileProperties [Snowflake](#cfn-appflow-connectorprofile-connectorprofileproperties-snowflake): SnowflakeConnectorProfileProperties [Veeva](#cfn-appflow-connectorprofile-connectorprofileproperties-veeva): VeevaConnectorProfileProperties [Zendesk](#cfn-appflow-connectorprofile-connectorprofileproperties-zendesk): ZendeskConnectorProfileProperties ``` ## Properties `CustomConnector` The properties required by the custom connector. *Required*: No *Type*: [CustomConnectorProfileProperties](aws-properties-appflow-connectorprofile-customconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Datadog` The connector-specific properties required by Datadog. *Required*: No *Type*: [DatadogConnectorProfileProperties](aws-properties-appflow-connectorprofile-datadogconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Dynatrace` The connector-specific properties required by Dynatrace. *Required*: No *Type*: [DynatraceConnectorProfileProperties](aws-properties-appflow-connectorprofile-dynatraceconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InforNexus` The connector-specific properties required by Infor Nexus. *Required*: No *Type*: [InforNexusConnectorProfileProperties](aws-properties-appflow-connectorprofile-infornexusconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Marketo` The connector-specific properties required by Marketo. *Required*: No *Type*: [MarketoConnectorProfileProperties](aws-properties-appflow-connectorprofile-marketoconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pardot` The connector-specific properties required by Salesforce Pardot. *Required*: No *Type*: [PardotConnectorProfileProperties](aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Redshift` The connector-specific properties required by Amazon Redshift. *Required*: No *Type*: [RedshiftConnectorProfileProperties](aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The connector-specific properties required by Salesforce. *Required*: No *Type*: [SalesforceConnectorProfileProperties](aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPOData` The connector-specific profile properties required when using SAPOData. *Required*: No *Type*: [SAPODataConnectorProfileProperties](aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` The connector-specific properties required by serviceNow. *Required*: No *Type*: [ServiceNowConnectorProfileProperties](aws-properties-appflow-connectorprofile-servicenowconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slack` The connector-specific properties required by Slack. *Required*: No *Type*: [SlackConnectorProfileProperties](aws-properties-appflow-connectorprofile-slackconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Snowflake` The connector-specific properties required by Snowflake. *Required*: No *Type*: [SnowflakeConnectorProfileProperties](aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Veeva` The connector-specific properties required by Veeva. *Required*: No *Type*: [VeevaConnectorProfileProperties](aws-properties-appflow-connectorprofile-veevaconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The connector-specific properties required by Zendesk. *Required*: No *Type*: [ZendeskConnectorProfileProperties](aws-properties-appflow-connectorprofile-zendeskconnectorprofileproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile CustomAuthCredentials The custom credentials required for custom authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CredentialsMap](#cfn-appflow-connectorprofile-customauthcredentials-credentialsmap)" : {Key: Value, ...}, "[CustomAuthenticationType](#cfn-appflow-connectorprofile-customauthcredentials-customauthenticationtype)" : String } ``` ### YAML ``` [CredentialsMap](#cfn-appflow-connectorprofile-customauthcredentials-credentialsmap): Key: Value [CustomAuthenticationType](#cfn-appflow-connectorprofile-customauthcredentials-customauthenticationtype): String ``` ## Properties `CredentialsMap` A map that holds custom authentication credentials. *Required*: No *Type*: Object of String *Pattern*: `^[\w]{1,128}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomAuthenticationType` The custom authentication type that the connector uses. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile CustomConnectorProfileCredentials The connector-specific profile credentials that are required when using the custom connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiKey](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-apikey)" : ApiKeyCredentials, "[AuthenticationType](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-authenticationtype)" : String, "[Basic](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-basic)" : BasicAuthCredentials, "[Custom](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-custom)" : CustomAuthCredentials, "[Oauth2](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-oauth2)" : OAuth2Credentials } ``` ### YAML ``` [ApiKey](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-apikey): ApiKeyCredentials [AuthenticationType](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-authenticationtype): String [Basic](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-basic): BasicAuthCredentials [Custom](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-custom): CustomAuthCredentials [Oauth2](#cfn-appflow-connectorprofile-customconnectorprofilecredentials-oauth2): OAuth2Credentials ``` ## Properties `ApiKey` The API keys required for the authentication of the user. *Required*: No *Type*: [ApiKeyCredentials](aws-properties-appflow-connectorprofile-apikeycredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationType` The authentication type that the custom connector uses for authenticating while creating a connector profile. *Required*: Yes *Type*: String *Allowed values*: `OAUTH2 | APIKEY | BASIC | CUSTOM` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Basic` The basic credentials that are required for the authentication of the user. *Required*: No *Type*: [BasicAuthCredentials](aws-properties-appflow-connectorprofile-basicauthcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Custom` If the connector uses the custom authentication mechanism, this holds the required credentials. *Required*: No *Type*: [CustomAuthCredentials](aws-properties-appflow-connectorprofile-customauthcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Oauth2` The OAuth 2.0 credentials required for the authentication of the user. *Required*: No *Type*: [OAuth2Credentials](aws-properties-appflow-connectorprofile-oauth2credentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile CustomConnectorProfileProperties The profile properties required by the custom connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OAuth2Properties](#cfn-appflow-connectorprofile-customconnectorprofileproperties-oauth2properties)" : OAuth2Properties, "[ProfileProperties](#cfn-appflow-connectorprofile-customconnectorprofileproperties-profileproperties)" : {Key: Value, ...} } ``` ### YAML ``` [OAuth2Properties](#cfn-appflow-connectorprofile-customconnectorprofileproperties-oauth2properties): OAuth2Properties [ProfileProperties](#cfn-appflow-connectorprofile-customconnectorprofileproperties-profileproperties): Key: Value ``` ## Properties `OAuth2Properties` The OAuth 2.0 properties required for OAuth 2.0 authentication. *Required*: No *Type*: [OAuth2Properties](aws-properties-appflow-connectorprofile-oauth2properties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProfileProperties` A map of properties that are required to create a profile for the custom connector. *Required*: No *Type*: Object of String *Pattern*: `^[\w]{1,256}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile DatadogConnectorProfileCredentials The connector-specific credentials required by Datadog. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiKey](#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-apikey)" : String, "[ApplicationKey](#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-applicationkey)" : String } ``` ### YAML ``` [ApiKey](#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-apikey): String [ApplicationKey](#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-applicationkey): String ``` ## Properties `ApiKey` A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApplicationKey` Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DatadogConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DatadogConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile DatadogConnectorProfileProperties The connector-specific profile properties required by Datadog. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-datadogconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-datadogconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Datadog resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DatadogConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DatadogConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile DynatraceConnectorProfileCredentials The connector-specific profile credentials required by Dynatrace. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiToken](#cfn-appflow-connectorprofile-dynatraceconnectorprofilecredentials-apitoken)" : String } ``` ### YAML ``` [ApiToken](#cfn-appflow-connectorprofile-dynatraceconnectorprofilecredentials-apitoken): String ``` ## Properties `ApiToken` The API tokens used by Dynatrace API to authenticate various API calls. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DynatraceConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DynatraceConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile DynatraceConnectorProfileProperties The connector-specific profile properties required by Dynatrace. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-dynatraceconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-dynatraceconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Dynatrace resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DynatraceConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DynatraceConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile GoogleAnalyticsConnectorProfileCredentials The connector-specific profile credentials required by Google Analytics. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientsecret)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest, "[RefreshToken](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientsecret): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest [RefreshToken](#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-refreshtoken): String ``` ## Properties `AccessToken` The credentials used to access protected Google Analytics resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the desired client. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [GoogleAnalyticsConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_GoogleAnalyticsConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile InforNexusConnectorProfileCredentials The connector-specific profile credentials required by Infor Nexus. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessKeyId](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-accesskeyid)" : String, "[Datakey](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-datakey)" : String, "[SecretAccessKey](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-secretaccesskey)" : String, "[UserId](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-userid)" : String } ``` ### YAML ``` [AccessKeyId](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-accesskeyid): String [Datakey](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-datakey): String [SecretAccessKey](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-secretaccesskey): String [UserId](#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-userid): String ``` ## Properties `AccessKeyId` The Access Key portion of the credentials. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Datakey` The encryption keys used to encrypt data. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretAccessKey` The secret key used to sign requests. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserId` The identifier for the user. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [InforNexusConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_InforNexusConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile InforNexusConnectorProfileProperties The connector-specific profile properties required by Infor Nexus. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-infornexusconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-infornexusconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Infor Nexus resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [InforNexusConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_InforNexusConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile MarketoConnectorProfileCredentials The connector-specific profile credentials required by Marketo. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientsecret)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientsecret): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest ``` ## Properties `AccessToken` The credentials used to access protected Marketo resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the desired client. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [MarketoConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_MarketoConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile MarketoConnectorProfileProperties The connector-specific profile properties required when using Marketo. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-marketoconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-marketoconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Marketo resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [MarketoConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_MarketoConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile OAuth2Credentials The OAuth 2.0 credentials required for OAuth 2.0 authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-oauth2credentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-oauth2credentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-oauth2credentials-clientsecret)" : String, "[OAuthRequest](#cfn-appflow-connectorprofile-oauth2credentials-oauthrequest)" : ConnectorOAuthRequest, "[RefreshToken](#cfn-appflow-connectorprofile-oauth2credentials-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-oauth2credentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-oauth2credentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-oauth2credentials-clientsecret): String [OAuthRequest](#cfn-appflow-connectorprofile-oauth2credentials-oauthrequest): ConnectorOAuthRequest [RefreshToken](#cfn-appflow-connectorprofile-oauth2credentials-refreshtoken): String ``` ## Properties `AccessToken` The access token used to access the connector on your behalf. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the desired client. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuthRequest` Property description not available. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The refresh token used to refresh an expired access token. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile OAuth2Properties The OAuth 2.0 properties required for OAuth 2.0 authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OAuth2GrantType](#cfn-appflow-connectorprofile-oauth2properties-oauth2granttype)" : String, "[TokenUrl](#cfn-appflow-connectorprofile-oauth2properties-tokenurl)" : String, "[TokenUrlCustomProperties](#cfn-appflow-connectorprofile-oauth2properties-tokenurlcustomproperties)" : {Key: Value, ...} } ``` ### YAML ``` [OAuth2GrantType](#cfn-appflow-connectorprofile-oauth2properties-oauth2granttype): String [TokenUrl](#cfn-appflow-connectorprofile-oauth2properties-tokenurl): String [TokenUrlCustomProperties](#cfn-appflow-connectorprofile-oauth2properties-tokenurlcustomproperties): Key: Value ``` ## Properties `OAuth2GrantType` The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication. *Required*: No *Type*: String *Allowed values*: `CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrl` The token URL required for OAuth 2.0 authentication. *Required*: No *Type*: String *Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrlCustomProperties` Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request. *Required*: No *Type*: Object of String *Pattern*: `^[\w]{1,128}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile OAuthCredentials The OAuth credentials required for OAuth type authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-oauthcredentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-oauthcredentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-oauthcredentials-clientsecret)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-oauthcredentials-connectoroauthrequest)" : ConnectorOAuthRequest, "[RefreshToken](#cfn-appflow-connectorprofile-oauthcredentials-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-oauthcredentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-oauthcredentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-oauthcredentials-clientsecret): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-oauthcredentials-connectoroauthrequest): ConnectorOAuthRequest [RefreshToken](#cfn-appflow-connectorprofile-oauthcredentials-refreshtoken): String ``` ## Properties `AccessToken` The access token used to access protected SAPOData resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the desired client. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Property description not available. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The refresh token used to refresh expired access token. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile OAuthProperties The OAuth properties required for OAuth type authentication. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthCodeUrl](#cfn-appflow-connectorprofile-oauthproperties-authcodeurl)" : String, "[OAuthScopes](#cfn-appflow-connectorprofile-oauthproperties-oauthscopes)" : [ String, ... ], "[TokenUrl](#cfn-appflow-connectorprofile-oauthproperties-tokenurl)" : String } ``` ### YAML ``` [AuthCodeUrl](#cfn-appflow-connectorprofile-oauthproperties-authcodeurl): String [OAuthScopes](#cfn-appflow-connectorprofile-oauthproperties-oauthscopes): - String [TokenUrl](#cfn-appflow-connectorprofile-oauthproperties-tokenurl): String ``` ## Properties `AuthCodeUrl` The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication. *Required*: No *Type*: String *Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuthScopes` The OAuth scopes required for OAuth type authentication. *Required*: No *Type*: Array of String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TokenUrl` The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token. *Required*: No *Type*: String *Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile PardotConnectorProfileCredentials The connector-specific profile credentials required when using Salesforce Pardot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-accesstoken)" : String, "[ClientCredentialsArn](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-clientcredentialsarn)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest, "[RefreshToken](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-accesstoken): String [ClientCredentialsArn](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-clientcredentialsarn): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest [RefreshToken](#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-refreshtoken): String ``` ## Properties `AccessToken` The credentials used to access protected Salesforce Pardot resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientCredentialsArn` The secret manager ARN, which contains the client ID and client secret of the connected app. *Required*: No *Type*: String *Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Property description not available. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The credentials used to acquire new access tokens. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile PardotConnectorProfileProperties The connector-specific profile properties required when using Salesforce Pardot. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BusinessUnitId](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-businessunitid)" : String, "[InstanceUrl](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-instanceurl)" : String, "[IsSandboxEnvironment](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-issandboxenvironment)" : Boolean } ``` ### YAML ``` [BusinessUnitId](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-businessunitid): String [InstanceUrl](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-instanceurl): String [IsSandboxEnvironment](#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-issandboxenvironment): Boolean ``` ## Properties `BusinessUnitId` The business unit id of Salesforce Pardot instance. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `18` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InstanceUrl` The location of the Salesforce Pardot resource. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsSandboxEnvironment` Indicates whether the connector profile applies to a sandbox or production environment. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileCredentials The connector-specific profile credentials required when using Amazon Redshift. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-password)" : String, "[Username](#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-username)" : String } ``` ### YAML ``` [Password](#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-password): String [Username](#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-username): String ``` ## Properties `Password` The password that corresponds to the user name. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The name of the user. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [RedshiftConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_RedshiftConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile RedshiftConnectorProfileProperties The connector-specific profile properties when using Amazon Redshift. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketname)" : String, "[BucketPrefix](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketprefix)" : String, "[ClusterIdentifier](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-clusteridentifier)" : String, "[DataApiRoleArn](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-dataapirolearn)" : String, "[DatabaseName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databasename)" : String, "[DatabaseUrl](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databaseurl)" : String, "[IsRedshiftServerless](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-isredshiftserverless)" : Boolean, "[RoleArn](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-rolearn)" : String, "[WorkgroupName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-workgroupname)" : String } ``` ### YAML ``` [BucketName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketname): String [BucketPrefix](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketprefix): String [ClusterIdentifier](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-clusteridentifier): String [DataApiRoleArn](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-dataapirolearn): String [DatabaseName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databasename): String [DatabaseUrl](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databaseurl): String [IsRedshiftServerless](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-isredshiftserverless): Boolean [RoleArn](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-rolearn): String [WorkgroupName](#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-workgroupname): String ``` ## Properties `BucketName` A name for the associated Amazon S3 bucket. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The object key for the destination bucket in which Amazon AppFlow places the files. *Required*: No *Type*: String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClusterIdentifier` The unique ID that's assigned to an Amazon Redshift cluster. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataApiRoleArn` The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see [Allow Amazon AppFlow to access Amazon Redshift databases with the Data API](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift). *Required*: No *Type*: String *Pattern*: `arn:aws:iam:.*:[0-9]+:.*` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseName` The name of an Amazon Redshift database. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DatabaseUrl` The JDBC URL of the Amazon Redshift cluster. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IsRedshiftServerless` Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see [Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3](https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3). *Required*: Yes *Type*: String *Pattern*: `arn:aws:iam:.*:[0-9]+:.*` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WorkgroupName` The name of an Amazon Redshift workgroup. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [RedshiftConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_RedshiftConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileCredentials The connector-specific profile credentials required when using Salesforce. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-accesstoken)" : String, "[ClientCredentialsArn](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-clientcredentialsarn)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest, "[JwtToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-jwttoken)" : String, "[OAuth2GrantType](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-oauth2granttype)" : String, "[RefreshToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-refreshtoken)" : String } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-accesstoken): String [ClientCredentialsArn](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-clientcredentialsarn): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest [JwtToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-jwttoken): String [OAuth2GrantType](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-oauth2granttype): String [RefreshToken](#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-refreshtoken): String ``` ## Properties `AccessToken` The credentials used to access protected Salesforce resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientCredentialsArn` The secret manager ARN, which contains the client ID and client secret of the connected app. *Required*: No *Type*: String *Pattern*: `arn:aws:secretsmanager:.*:[0-9]+:.*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JwtToken` A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records. *Required*: No *Type*: String *Pattern*: `^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.[A-Za-z0-9-_.+/=]*$` *Maximum*: `8000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuth2GrantType` Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records. You can specify one of the following values: AUTHORIZATION\$1CODE Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records. JWT\$1BEARER Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records. The CLIENT\$1CREDENTIALS value is not supported for Salesforce. *Required*: No *Type*: String *Allowed values*: `CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RefreshToken` The credentials used to acquire new access tokens. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SalesforceConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SalesforceConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SalesforceConnectorProfileProperties The connector-specific profile properties required when using Salesforce. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-instanceurl)" : String, "[isSandboxEnvironment](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-issandboxenvironment)" : Boolean, "[usePrivateLinkForMetadataAndAuthorization](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-useprivatelinkformetadataandauthorization)" : Boolean } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-instanceurl): String [isSandboxEnvironment](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-issandboxenvironment): Boolean [usePrivateLinkForMetadataAndAuthorization](#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-useprivatelinkformetadataandauthorization): Boolean ``` ## Properties `InstanceUrl` The location of the Salesforce resource. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `isSandboxEnvironment` Indicates whether the connector profile applies to a sandbox or production environment. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `usePrivateLinkForMetadataAndAuthorization` If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through AWS PrivateLink. These calls travel through AWS infrastructure without being exposed to the public internet. Set either of the following values: true Amazon AppFlow sends all calls to Salesforce over the private network. These private calls are: + Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields. + Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records. + Calls to transfer your Salesforce records as part of a flow run. false The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet. The public calls are: + Calls to get metadata about your Salesforce records. + Calls to get or refresh access tokens. The private calls are: + Calls to transfer your Salesforce records as part of a flow run. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SalesforceConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SalesforceConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SAPODataConnectorProfileCredentials The connector-specific profile credentials required when using SAPOData. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BasicAuthCredentials](#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-basicauthcredentials)" : BasicAuthCredentials, "[OAuthCredentials](#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-oauthcredentials)" : OAuthCredentials } ``` ### YAML ``` [BasicAuthCredentials](#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-basicauthcredentials): BasicAuthCredentials [OAuthCredentials](#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-oauthcredentials): OAuthCredentials ``` ## Properties `BasicAuthCredentials` The SAPOData basic authentication credentials. *Required*: No *Type*: [BasicAuthCredentials](aws-properties-appflow-connectorprofile-basicauthcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuthCredentials` The SAPOData OAuth type authentication credentials. *Required*: No *Type*: [OAuthCredentials](aws-properties-appflow-connectorprofile-oauthcredentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile SAPODataConnectorProfileProperties The connector-specific profile properties required when using SAPOData. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApplicationHostUrl](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationhosturl)" : String, "[ApplicationServicePath](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationservicepath)" : String, "[ClientNumber](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-clientnumber)" : String, "[DisableSSO](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-disablesso)" : Boolean, "[LogonLanguage](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-logonlanguage)" : String, "[OAuthProperties](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-oauthproperties)" : OAuthProperties, "[PortNumber](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-portnumber)" : Integer, "[PrivateLinkServiceName](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-privatelinkservicename)" : String } ``` ### YAML ``` [ApplicationHostUrl](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationhosturl): String [ApplicationServicePath](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationservicepath): String [ClientNumber](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-clientnumber): String [DisableSSO](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-disablesso): Boolean [LogonLanguage](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-logonlanguage): String [OAuthProperties](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-oauthproperties): OAuthProperties [PortNumber](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-portnumber): Integer [PrivateLinkServiceName](#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-privatelinkservicename): String ``` ## Properties `ApplicationHostUrl` The location of the SAPOData resource. *Required*: No *Type*: String *Pattern*: `^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApplicationServicePath` The application path to catalog service. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientNumber` The client number for the client creating the connection. *Required*: No *Type*: String *Pattern*: `^\d{3}$` *Minimum*: `3` *Maximum*: `3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisableSSO` 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. Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogonLanguage` The logon language of SAPOData instance. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_]*$` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OAuthProperties` The SAPOData OAuth properties required for OAuth type authentication. *Required*: No *Type*: [OAuthProperties](aws-properties-appflow-connectorprofile-oauthproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PortNumber` The port number of the SAPOData instance. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `65535` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrivateLinkServiceName` The SAPOData Private Link service name to be used for private data transfers. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::ConnectorProfile ServiceNowConnectorProfileCredentials The connector-specific profile credentials required when using ServiceNow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OAuth2Credentials](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-oauth2credentials)" : OAuth2Credentials, "[Password](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-password)" : String, "[Username](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-username)" : String } ``` ### YAML ``` [OAuth2Credentials](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-oauth2credentials): OAuth2Credentials [Password](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-password): String [Username](#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-username): String ``` ## Properties `OAuth2Credentials` The OAuth 2.0 credentials required to authenticate the user. *Required*: No *Type*: [OAuth2Credentials](aws-properties-appflow-connectorprofile-oauth2credentials.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Password` The password that corresponds to the user name. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The name of the user. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ServiceNowConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ServiceNowConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ServiceNowConnectorProfileProperties The connector-specific profile properties required when using ServiceNow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-servicenowconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-servicenowconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the ServiceNow resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ServiceNowConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ServiceNowConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SingularConnectorProfileCredentials The connector-specific profile credentials required when using Singular. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiKey](#cfn-appflow-connectorprofile-singularconnectorprofilecredentials-apikey)" : String } ``` ### YAML ``` [ApiKey](#cfn-appflow-connectorprofile-singularconnectorprofilecredentials-apikey): String ``` ## Properties `ApiKey` A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SingularConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SingularConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SlackConnectorProfileCredentials The connector-specific profile credentials required when using Slack. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientsecret)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientsecret): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest ``` ## Properties `AccessToken` The credentials used to access protected Slack resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the client. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SlackConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SlackConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SlackConnectorProfileProperties The connector-specific profile properties required when using Slack. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-slackconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-slackconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Slack resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SlackConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SlackConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SnowflakeConnectorProfileCredentials The connector-specific profile credentials required when using Snowflake. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-password)" : String, "[Username](#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-username)" : String } ``` ### YAML ``` [Password](#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-password): String [Username](#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-username): String ``` ## Properties `Password` The password that corresponds to the user name. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The name of the user. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SnowflakeConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SnowflakeConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile SnowflakeConnectorProfileProperties The connector-specific profile properties required when using Snowflake. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccountName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-accountname)" : String, "[BucketName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketname)" : String, "[BucketPrefix](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketprefix)" : String, "[PrivateLinkServiceName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-privatelinkservicename)" : String, "[Region](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-region)" : String, "[Stage](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-stage)" : String, "[Warehouse](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-warehouse)" : String } ``` ### YAML ``` [AccountName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-accountname): String [BucketName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketname): String [BucketPrefix](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketprefix): String [PrivateLinkServiceName](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-privatelinkservicename): String [Region](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-region): String [Stage](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-stage): String [Warehouse](#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-warehouse): String ``` ## Properties `AccountName` The name of the account. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketName` The name of the Amazon S3 bucket associated with Snowflake. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The bucket path that refers to the Amazon S3 bucket associated with Snowflake. *Required*: No *Type*: String *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrivateLinkServiceName` The Snowflake Private Link service name to be used for private data transfers. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Region` The AWS Region of the Snowflake account. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Stage` The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema>. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Warehouse` The name of the Snowflake warehouse. *Required*: Yes *Type*: String *Pattern*: `[\s\w/!@#+=.-]*` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SnowflakeConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SnowflakeConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile TrendmicroConnectorProfileCredentials The connector-specific profile credentials required when using Trend Micro. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiSecretKey](#cfn-appflow-connectorprofile-trendmicroconnectorprofilecredentials-apisecretkey)" : String } ``` ### YAML ``` [ApiSecretKey](#cfn-appflow-connectorprofile-trendmicroconnectorprofilecredentials-apisecretkey): String ``` ## Properties `ApiSecretKey` The Secret Access Key portion of the credentials. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [TrendmicroConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_TrendmicroConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile VeevaConnectorProfileCredentials The connector-specific profile credentials required when using Veeva. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Password](#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-password)" : String, "[Username](#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-username)" : String } ``` ### YAML ``` [Password](#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-password): String [Username](#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-username): String ``` ## Properties `Password` The password that corresponds to the user name. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Username` The name of the user. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [VeevaConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_VeevaConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile VeevaConnectorProfileProperties The connector-specific profile properties required when using Veeva. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-veevaconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-veevaconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Veeva resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [VeevaConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_VeevaConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ZendeskConnectorProfileCredentials The connector-specific profile credentials required when using Zendesk. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccessToken](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-accesstoken)" : String, "[ClientId](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientid)" : String, "[ClientSecret](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientsecret)" : String, "[ConnectorOAuthRequest](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-connectoroauthrequest)" : ConnectorOAuthRequest } ``` ### YAML ``` [AccessToken](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-accesstoken): String [ClientId](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientid): String [ClientSecret](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientsecret): String [ConnectorOAuthRequest](#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-connectoroauthrequest): ConnectorOAuthRequest ``` ## Properties `AccessToken` The credentials used to access protected Zendesk resources. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientId` The identifier for the desired client. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ClientSecret` The client secret used by the OAuth client to authenticate to the authorization server. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorOAuthRequest` Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. *Required*: No *Type*: [ConnectorOAuthRequest](aws-properties-appflow-connectorprofile-connectoroauthrequest.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ZendeskConnectorProfileCredentials](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ZendeskConnectorProfileCredentials.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::ConnectorProfile ZendeskConnectorProfileProperties The connector-specific profile properties required when using Zendesk. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InstanceUrl](#cfn-appflow-connectorprofile-zendeskconnectorprofileproperties-instanceurl)" : String } ``` ### YAML ``` [InstanceUrl](#cfn-appflow-connectorprofile-zendeskconnectorprofileproperties-instanceurl): String ``` ## Properties `InstanceUrl` The location of the Zendesk resource. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ZendeskConnectorProfileProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ZendeskConnectorProfileProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow The `AWS::AppFlow::Flow` resource is an Amazon AppFlow resource type that specifies a new flow. **Note** If you want to use CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::AppFlow::Flow", "Properties" : { "[Description](#cfn-appflow-flow-description)" : String, "[DestinationFlowConfigList](#cfn-appflow-flow-destinationflowconfiglist)" : [ DestinationFlowConfig, ... ], "[FlowName](#cfn-appflow-flow-flowname)" : String, "[FlowStatus](#cfn-appflow-flow-flowstatus)" : String, "[KMSArn](#cfn-appflow-flow-kmsarn)" : String, "[MetadataCatalogConfig](#cfn-appflow-flow-metadatacatalogconfig)" : MetadataCatalogConfig, "[SourceFlowConfig](#cfn-appflow-flow-sourceflowconfig)" : SourceFlowConfig, "[Tags](#cfn-appflow-flow-tags)" : [ Tag, ... ], "[Tasks](#cfn-appflow-flow-tasks)" : [ Task, ... ], "[TriggerConfig](#cfn-appflow-flow-triggerconfig)" : TriggerConfig } } ``` ### YAML ``` Type: AWS::AppFlow::Flow Properties: [Description](#cfn-appflow-flow-description): String [DestinationFlowConfigList](#cfn-appflow-flow-destinationflowconfiglist): - DestinationFlowConfig [FlowName](#cfn-appflow-flow-flowname): String [FlowStatus](#cfn-appflow-flow-flowstatus): String [KMSArn](#cfn-appflow-flow-kmsarn): String [MetadataCatalogConfig](#cfn-appflow-flow-metadatacatalogconfig): MetadataCatalogConfig [SourceFlowConfig](#cfn-appflow-flow-sourceflowconfig): SourceFlowConfig [Tags](#cfn-appflow-flow-tags): - Tag [Tasks](#cfn-appflow-flow-tasks): - Task [TriggerConfig](#cfn-appflow-flow-triggerconfig): TriggerConfig ``` ## Properties `Description` A user-entered description of the flow. *Required*: No *Type*: String *Pattern*: `[\w!@#\-.?,\s]*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationFlowConfigList` The configuration that controls how Amazon AppFlow places data in the destination connector. *Required*: Yes *Type*: Array of [DestinationFlowConfig](aws-properties-appflow-flow-destinationflowconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FlowName` The specified name of the flow. Spaces are not allowed. Use underscores (\$1) or hyphens (-) only. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9][\w!@#.-]+` *Minimum*: `1` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FlowStatus` Sets the status of the flow. You can specify one of the following values: Active The flow runs based on the trigger settings that you defined. Active scheduled flows run as scheduled, and active event-triggered flows run when the specified change event occurs. However, active on-demand flows run only when you manually start them by using Amazon AppFlow. Suspended You can use this option to deactivate an active flow. Scheduled and event-triggered flows will cease to run until you reactive them. This value only affects scheduled and event-triggered flows. It has no effect for on-demand flows. If you omit the FlowStatus parameter, Amazon AppFlow creates the flow with a default status. The default status for on-demand flows is Active. The default status for scheduled and event-triggered flows is Draft, which means they’re not yet active. *Required*: No *Type*: String *Allowed values*: `Active | Suspended | Draft` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KMSArn` The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. *Required*: No *Type*: String *Pattern*: `arn:aws:kms:.*:[0-9]+:.*` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MetadataCatalogConfig` Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog. *Required*: No *Type*: [MetadataCatalogConfig](aws-properties-appflow-flow-metadatacatalogconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceFlowConfig` Contains information about the configuration of the source connector used in the flow. *Required*: Yes *Type*: [SourceFlowConfig](aws-properties-appflow-flow-sourceflowconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags used to organize, track, or control access for your flow. *Required*: No *Type*: Array of [Tag](aws-properties-appflow-flow-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tasks` A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. *Required*: Yes *Type*: Array of [Task](aws-properties-appflow-flow-task.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TriggerConfig` The trigger settings that determine how and when Amazon AppFlow runs the specified flow. *Required*: Yes *Type*: [TriggerConfig](aws-properties-appflow-flow-triggerconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the flow name. For example: `{ "Ref": "myFlowName" }` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `FlowArn` The flow's Amazon Resource Name (ARN). ## Examples ### Test flow for CloudFormation from Salesforce to Amazon S3 The following example shows a test event flow for CloudFormation using Salesforce as the source and Amazon S3 as the destination. #### JSON ``` { "AWSTemplateFormatVersion":"2010-09-09", "Resources": { "TestFlow": { "Type": "AWS::AppFlow::Flow", "Properties": { "flowName": "MyEventFlow", "description": "Test event flow for CloudFormation from salesforce to s3", "triggerConfig": { "triggerType": "Event" }, "sourceFlowConfig": { "connectorType": "Salesforce", "connectorProfileName": "TestConnectorProfile", "sourceConnectorProperties": { "Salesforce": { "object": "Account", "enableDynamicFieldUpdate": false, "includeDeletedRecords": true } } }, "destinationFlowConfigList": [ { "connectorType": "S3", "destinationConnectorProperties": { "S3": { "bucketName": "TestOutputBucket", "s3OutputFormatConfig": { "fileType": "JSON", "aggregationConfig": { "aggregationType": "None" } } } } } ], "tasks": [ { "taskType": "Filter", "sourceFields": [ "Id", "Name" ], "connectorOperator": { "Salesforce": "PROJECTION" } }, { "taskType": "Map", "sourceFields": [ "Id" ], "taskProperties": [ { "Key": "SOURCE_DATA_TYPE", "Value": "id" }, { "Key": "DESTINATION_DATA_TYPE", "Value": "id" } ], "destinationField": "Id", "connectorOperator": { "Salesforce": "NO_OP" } }, { "taskType": "Map", "sourceFields": [ "Name" ], "taskProperties": [ { "Key": "SOURCE_DATA_TYPE", "Value": "string" }, { "Key": "DESTINATION_DATA_TYPE", "Value": "string" } ], "destinationField": "Name", "connectorOperator": { "Salesforce": "NO_OP" } } ], "tags": [ { "Key": "testKey", "Value": "testValue" } ] } } } } ``` #### YAML ``` AWSTemplateFormatVersion: '2010-09-09' Resources: TestFlow: Type: AWS::AppFlow::Flow Properties: FlowName: MyEventFlow Description: Test flow for CloudFormation from salesforce to s3 TriggerConfig: TriggerType: Event SourceFlowConfig: ConnectorType: Salesforce ConnectorProfileName: TestConnectorProfile SourceConnectorProperties: Salesforce: Object: Account EnableDynamicFieldUpdate: false IncludeDeletedRecords: true DestinationFlowConfigList: - ConnectorType: S3 DestinationConnectorProperties: S3: BucketName: TestOutputBucket S3OutputFormatConfig: FileType: JSON AggregationConfig: AggregationType: None Tasks: - TaskType: Filter ConnectorOperator: Salesforce: PROJECTION SourceFields: - Id - TaskType: Map SourceFields: - Id TaskProperties: - Key: SOURCE_DATA_TYPE Value: id - Key: DESTINATION_DATA_TYPE Value: id DestinationField: Id ConnectorOperator: Salesforce: NO_OP - TaskType: Map SourceFields: - Name TaskProperties: - Key: SOURCE_DATA_TYPE Value: string - Key: DESTINATION_DATA_TYPE Value: string DestinationField: Name ConnectorOperator: Salesforce: NO_OP ``` ## See also + [CreateFlow](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_CreateFlow.html) in the *Amazon AppFlow API Reference*. + [DescribeFlow](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DescribeFlow.html) in the *Amazon AppFlow API Reference*. + [DeleteFlow](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DeleteFlow.html) in the *Amazon AppFlow API Reference*. + [UpdateFlow](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_UpdateFlow.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow AggregationConfig The aggregation settings that you can use to customize the output format of your flow data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregationType](#cfn-appflow-flow-aggregationconfig-aggregationtype)" : String, "[TargetFileSize](#cfn-appflow-flow-aggregationconfig-targetfilesize)" : Integer } ``` ### YAML ``` [AggregationType](#cfn-appflow-flow-aggregationconfig-aggregationtype): String [TargetFileSize](#cfn-appflow-flow-aggregationconfig-targetfilesize): Integer ``` ## Properties `AggregationType` Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated. *Required*: No *Type*: String *Allowed values*: `None | SingleFile` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetFileSize` The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The actual file sizes might differ from this target based on the number and size of the records that each file contains. *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [AggregationConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_AggregationConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow AmplitudeSourceProperties The properties that are applied when Amplitude is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-amplitudesourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-amplitudesourceproperties-object): String ``` ## Properties `Object` The object specified in the Amplitude flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [AmplitudeSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_AmplitudeSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow ConnectorOperator The operation to be performed on the provided source fields. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Amplitude](#cfn-appflow-flow-connectoroperator-amplitude)" : String, "[CustomConnector](#cfn-appflow-flow-connectoroperator-customconnector)" : String, "[Datadog](#cfn-appflow-flow-connectoroperator-datadog)" : String, "[Dynatrace](#cfn-appflow-flow-connectoroperator-dynatrace)" : String, "[GoogleAnalytics](#cfn-appflow-flow-connectoroperator-googleanalytics)" : String, "[InforNexus](#cfn-appflow-flow-connectoroperator-infornexus)" : String, "[Marketo](#cfn-appflow-flow-connectoroperator-marketo)" : String, "[Pardot](#cfn-appflow-flow-connectoroperator-pardot)" : String, "[S3](#cfn-appflow-flow-connectoroperator-s3)" : String, "[Salesforce](#cfn-appflow-flow-connectoroperator-salesforce)" : String, "[SAPOData](#cfn-appflow-flow-connectoroperator-sapodata)" : String, "[ServiceNow](#cfn-appflow-flow-connectoroperator-servicenow)" : String, "[Singular](#cfn-appflow-flow-connectoroperator-singular)" : String, "[Slack](#cfn-appflow-flow-connectoroperator-slack)" : String, "[Trendmicro](#cfn-appflow-flow-connectoroperator-trendmicro)" : String, "[Veeva](#cfn-appflow-flow-connectoroperator-veeva)" : String, "[Zendesk](#cfn-appflow-flow-connectoroperator-zendesk)" : String } ``` ### YAML ``` [Amplitude](#cfn-appflow-flow-connectoroperator-amplitude): String [CustomConnector](#cfn-appflow-flow-connectoroperator-customconnector): String [Datadog](#cfn-appflow-flow-connectoroperator-datadog): String [Dynatrace](#cfn-appflow-flow-connectoroperator-dynatrace): String [GoogleAnalytics](#cfn-appflow-flow-connectoroperator-googleanalytics): String [InforNexus](#cfn-appflow-flow-connectoroperator-infornexus): String [Marketo](#cfn-appflow-flow-connectoroperator-marketo): String [Pardot](#cfn-appflow-flow-connectoroperator-pardot): String [S3](#cfn-appflow-flow-connectoroperator-s3): String [Salesforce](#cfn-appflow-flow-connectoroperator-salesforce): String [SAPOData](#cfn-appflow-flow-connectoroperator-sapodata): String [ServiceNow](#cfn-appflow-flow-connectoroperator-servicenow): String [Singular](#cfn-appflow-flow-connectoroperator-singular): String [Slack](#cfn-appflow-flow-connectoroperator-slack): String [Trendmicro](#cfn-appflow-flow-connectoroperator-trendmicro): String [Veeva](#cfn-appflow-flow-connectoroperator-veeva): String [Zendesk](#cfn-appflow-flow-connectoroperator-zendesk): String ``` ## Properties `Amplitude` The operation to be performed on the provided Amplitude source fields. *Required*: No *Type*: String *Allowed values*: `BETWEEN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomConnector` Operators supported by the custom connector. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Datadog` The operation to be performed on the provided Datadog source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Dynatrace` The operation to be performed on the provided Dynatrace source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GoogleAnalytics` The operation to be performed on the provided Google Analytics source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | BETWEEN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InforNexus` The operation to be performed on the provided Infor Nexus source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Marketo` The operation to be performed on the provided Marketo source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pardot` The operation to be performed on the provided Salesforce Pardot source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | EQUAL_TO | NO_OP | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` The operation to be performed on the provided Amazon S3 source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The operation to be performed on the provided Salesforce source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPOData` The operation to be performed on the provided SAPOData source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` The operation to be performed on the provided ServiceNow source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Singular` The operation to be performed on the provided Singular source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slack` The operation to be performed on the provided Slack source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Trendmicro` The operation to be performed on the provided Trend Micro source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Veeva` The operation to be performed on the provided Veeva source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The operation to be performed on the provided Zendesk source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | GREATER_THAN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ConnectorOperator](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ConnectorOperator.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow CustomConnectorDestinationProperties The properties that are applied when the custom connector is being used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomProperties](#cfn-appflow-flow-customconnectordestinationproperties-customproperties)" : {Key: Value, ...}, "[EntityName](#cfn-appflow-flow-customconnectordestinationproperties-entityname)" : String, "[ErrorHandlingConfig](#cfn-appflow-flow-customconnectordestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IdFieldNames](#cfn-appflow-flow-customconnectordestinationproperties-idfieldnames)" : [ String, ... ], "[WriteOperationType](#cfn-appflow-flow-customconnectordestinationproperties-writeoperationtype)" : String } ``` ### YAML ``` [CustomProperties](#cfn-appflow-flow-customconnectordestinationproperties-customproperties): Key: Value [EntityName](#cfn-appflow-flow-customconnectordestinationproperties-entityname): String [ErrorHandlingConfig](#cfn-appflow-flow-customconnectordestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IdFieldNames](#cfn-appflow-flow-customconnectordestinationproperties-idfieldnames): - String [WriteOperationType](#cfn-appflow-flow-customconnectordestinationproperties-writeoperationtype): String ``` ## Properties `CustomProperties` The custom properties that are specific to the connector when it's used as a destination in the flow. *Required*: No *Type*: Object of String *Pattern*: `^[\w]{1,2048}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntityName` The entity specified in the custom connector as a destination in the flow. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as destination. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdFieldNames` The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete, or upsert. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WriteOperationType` Specifies the type of write operation to be performed in the custom connector when it's used as destination. *Required*: No *Type*: String *Allowed values*: `INSERT | UPSERT | UPDATE | DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow CustomConnectorSourceProperties The properties that are applied when the custom connector is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomProperties](#cfn-appflow-flow-customconnectorsourceproperties-customproperties)" : {Key: Value, ...}, "[DataTransferApi](#cfn-appflow-flow-customconnectorsourceproperties-datatransferapi)" : DataTransferApi, "[EntityName](#cfn-appflow-flow-customconnectorsourceproperties-entityname)" : String } ``` ### YAML ``` [CustomProperties](#cfn-appflow-flow-customconnectorsourceproperties-customproperties): Key: Value [DataTransferApi](#cfn-appflow-flow-customconnectorsourceproperties-datatransferapi): DataTransferApi [EntityName](#cfn-appflow-flow-customconnectorsourceproperties-entityname): String ``` ## Properties `CustomProperties` Custom properties that are required to use the custom connector as a source. *Required*: No *Type*: Object of String *Pattern*: `^[\w]{1,2048}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataTransferApi` The API of the connector application that Amazon AppFlow uses to transfer your data. *Required*: No *Type*: [DataTransferApi](aws-properties-appflow-flow-datatransferapi.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntityName` The entity specified in the custom connector as a source in the flow. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow DatadogSourceProperties The properties that are applied when Datadog is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-datadogsourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-datadogsourceproperties-object): String ``` ## Properties `Object` The object specified in the Datadog flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DatadogSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DatadogSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow DataTransferApi The API of the connector application that Amazon AppFlow uses to transfer your data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-appflow-flow-datatransferapi-name)" : String, "[Type](#cfn-appflow-flow-datatransferapi-type)" : String } ``` ### YAML ``` [Name](#cfn-appflow-flow-datatransferapi-name): String [Type](#cfn-appflow-flow-datatransferapi-type): String ``` ## Properties `Name` The name of the connector application API. *Required*: Yes *Type*: String *Pattern*: `[\w/-]+` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` You can specify one of the following types: AUTOMATIC The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers. SYNC A synchronous API. This type of API optimizes a flow for small to medium-sized datasets. ASYNC An asynchronous API. This type of API optimizes a flow for large datasets. *Required*: Yes *Type*: String *Allowed values*: `SYNC | ASYNC | AUTOMATIC` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow DestinationConnectorProperties This stores the information that is required to query a particular connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomConnector](#cfn-appflow-flow-destinationconnectorproperties-customconnector)" : CustomConnectorDestinationProperties, "[EventBridge](#cfn-appflow-flow-destinationconnectorproperties-eventbridge)" : EventBridgeDestinationProperties, "[LookoutMetrics](#cfn-appflow-flow-destinationconnectorproperties-lookoutmetrics)" : LookoutMetricsDestinationProperties, "[Marketo](#cfn-appflow-flow-destinationconnectorproperties-marketo)" : MarketoDestinationProperties, "[Redshift](#cfn-appflow-flow-destinationconnectorproperties-redshift)" : RedshiftDestinationProperties, "[S3](#cfn-appflow-flow-destinationconnectorproperties-s3)" : S3DestinationProperties, "[Salesforce](#cfn-appflow-flow-destinationconnectorproperties-salesforce)" : SalesforceDestinationProperties, "[SAPOData](#cfn-appflow-flow-destinationconnectorproperties-sapodata)" : SAPODataDestinationProperties, "[Snowflake](#cfn-appflow-flow-destinationconnectorproperties-snowflake)" : SnowflakeDestinationProperties, "[Upsolver](#cfn-appflow-flow-destinationconnectorproperties-upsolver)" : UpsolverDestinationProperties, "[Zendesk](#cfn-appflow-flow-destinationconnectorproperties-zendesk)" : ZendeskDestinationProperties } ``` ### YAML ``` [CustomConnector](#cfn-appflow-flow-destinationconnectorproperties-customconnector): CustomConnectorDestinationProperties [EventBridge](#cfn-appflow-flow-destinationconnectorproperties-eventbridge): EventBridgeDestinationProperties [LookoutMetrics](#cfn-appflow-flow-destinationconnectorproperties-lookoutmetrics): LookoutMetricsDestinationProperties [Marketo](#cfn-appflow-flow-destinationconnectorproperties-marketo): MarketoDestinationProperties [Redshift](#cfn-appflow-flow-destinationconnectorproperties-redshift): RedshiftDestinationProperties [S3](#cfn-appflow-flow-destinationconnectorproperties-s3): S3DestinationProperties [Salesforce](#cfn-appflow-flow-destinationconnectorproperties-salesforce): SalesforceDestinationProperties [SAPOData](#cfn-appflow-flow-destinationconnectorproperties-sapodata): SAPODataDestinationProperties [Snowflake](#cfn-appflow-flow-destinationconnectorproperties-snowflake): SnowflakeDestinationProperties [Upsolver](#cfn-appflow-flow-destinationconnectorproperties-upsolver): UpsolverDestinationProperties [Zendesk](#cfn-appflow-flow-destinationconnectorproperties-zendesk): ZendeskDestinationProperties ``` ## Properties `CustomConnector` The properties that are required to query the custom Connector. *Required*: No *Type*: [CustomConnectorDestinationProperties](aws-properties-appflow-flow-customconnectordestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EventBridge` The properties required to query Amazon EventBridge. *Required*: No *Type*: [EventBridgeDestinationProperties](aws-properties-appflow-flow-eventbridgedestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LookoutMetrics` The properties required to query Amazon Lookout for Metrics. *Required*: No *Type*: [LookoutMetricsDestinationProperties](aws-properties-appflow-flow-lookoutmetricsdestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Marketo` The properties required to query Marketo. *Required*: No *Type*: [MarketoDestinationProperties](aws-properties-appflow-flow-marketodestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Redshift` The properties required to query Amazon Redshift. *Required*: No *Type*: [RedshiftDestinationProperties](aws-properties-appflow-flow-redshiftdestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` The properties required to query Amazon S3. *Required*: No *Type*: [S3DestinationProperties](aws-properties-appflow-flow-s3destinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The properties required to query Salesforce. *Required*: No *Type*: [SalesforceDestinationProperties](aws-properties-appflow-flow-salesforcedestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPOData` The properties required to query SAPOData. *Required*: No *Type*: [SAPODataDestinationProperties](aws-properties-appflow-flow-sapodatadestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Snowflake` The properties required to query Snowflake. *Required*: No *Type*: [SnowflakeDestinationProperties](aws-properties-appflow-flow-snowflakedestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Upsolver` The properties required to query Upsolver. *Required*: No *Type*: [UpsolverDestinationProperties](aws-properties-appflow-flow-upsolverdestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The properties required to query Zendesk. *Required*: No *Type*: [ZendeskDestinationProperties](aws-properties-appflow-flow-zendeskdestinationproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DestinationConnectorProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DestinationConnectorProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow DestinationFlowConfig Contains information about the configuration of destination connectors present in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiVersion](#cfn-appflow-flow-destinationflowconfig-apiversion)" : String, "[ConnectorProfileName](#cfn-appflow-flow-destinationflowconfig-connectorprofilename)" : String, "[ConnectorType](#cfn-appflow-flow-destinationflowconfig-connectortype)" : String, "[DestinationConnectorProperties](#cfn-appflow-flow-destinationflowconfig-destinationconnectorproperties)" : DestinationConnectorProperties } ``` ### YAML ``` [ApiVersion](#cfn-appflow-flow-destinationflowconfig-apiversion): String [ConnectorProfileName](#cfn-appflow-flow-destinationflowconfig-connectorprofilename): String [ConnectorType](#cfn-appflow-flow-destinationflowconfig-connectortype): String [DestinationConnectorProperties](#cfn-appflow-flow-destinationflowconfig-destinationconnectorproperties): DestinationConnectorProperties ``` ## Properties `ApiVersion` The API version that the destination connector uses. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorProfileName` The name of the connector profile. This name must be unique for each connector profile in the AWS account. *Required*: No *Type*: String *Pattern*: `[\w/!@#+=.-]+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorType` The type of destination connector, such as Sales force, Amazon S3, and so on. *Required*: Yes *Type*: String *Allowed values*: `SAPOData | Salesforce | Pardot | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | CustomConnector | EventBridge | Upsolver | LookoutMetrics` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationConnectorProperties` This stores the information that is required to query a particular connector. *Required*: Yes *Type*: [DestinationConnectorProperties](aws-properties-appflow-flow-destinationconnectorproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DestinationConnectorProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DestinationConnectorProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow DynatraceSourceProperties The properties that are applied when Dynatrace is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-dynatracesourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-dynatracesourceproperties-object): String ``` ## Properties `Object` The object specified in the Dynatrace flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [DynatraceSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_DynatraceSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow ErrorHandlingConfig The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-flow-errorhandlingconfig-bucketname)" : String, "[BucketPrefix](#cfn-appflow-flow-errorhandlingconfig-bucketprefix)" : String, "[FailOnFirstError](#cfn-appflow-flow-errorhandlingconfig-failonfirsterror)" : Boolean } ``` ### YAML ``` [BucketName](#cfn-appflow-flow-errorhandlingconfig-bucketname): String [BucketPrefix](#cfn-appflow-flow-errorhandlingconfig-bucketprefix): String [FailOnFirstError](#cfn-appflow-flow-errorhandlingconfig-failonfirsterror): Boolean ``` ## Properties `BucketName` Specifies the name of the Amazon S3 bucket. *Required*: No *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` Specifies the Amazon S3 bucket prefix. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailOnFirstError` Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ErrorHandlingConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ErrorHandlingConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow EventBridgeDestinationProperties The properties that are applied when Amazon EventBridge is being used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ErrorHandlingConfig](#cfn-appflow-flow-eventbridgedestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[Object](#cfn-appflow-flow-eventbridgedestinationproperties-object)" : String } ``` ### YAML ``` [ErrorHandlingConfig](#cfn-appflow-flow-eventbridgedestinationproperties-errorhandlingconfig): ErrorHandlingConfig [Object](#cfn-appflow-flow-eventbridgedestinationproperties-object): String ``` ## Properties `ErrorHandlingConfig` The object specified in the Amplitude flow source. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Amazon EventBridge flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [EventBridgeDestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_EventBridgeDestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow GlueDataCatalog The `GlueDataCatalog` property type specifies Property description not available. for an [AWS::AppFlow::Flow](aws-resource-appflow-flow.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseName](#cfn-appflow-flow-gluedatacatalog-databasename)" : String, "[RoleArn](#cfn-appflow-flow-gluedatacatalog-rolearn)" : String, "[TablePrefix](#cfn-appflow-flow-gluedatacatalog-tableprefix)" : String } ``` ### YAML ``` [DatabaseName](#cfn-appflow-flow-gluedatacatalog-databasename): String [RoleArn](#cfn-appflow-flow-gluedatacatalog-rolearn): String [TablePrefix](#cfn-appflow-flow-gluedatacatalog-tableprefix): String ``` ## Properties `DatabaseName` Property description not available. *Required*: Yes *Type*: String *Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` *Minimum*: `0` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` Property description not available. *Required*: Yes *Type*: String *Pattern*: `arn:aws:iam:.*:[0-9]+:.*` *Minimum*: `0` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TablePrefix` Property description not available. *Required*: Yes *Type*: String *Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*` *Minimum*: `0` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow GoogleAnalyticsSourceProperties The properties that are applied when Google Analytics is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-googleanalyticssourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-googleanalyticssourceproperties-object): String ``` ## Properties `Object` The object specified in the Google Analytics flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [GoogleAnalyticsSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_GoogleAnalyticsSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow IncrementalPullConfig Specifies the configuration used when importing incremental records from the source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatetimeTypeFieldName](#cfn-appflow-flow-incrementalpullconfig-datetimetypefieldname)" : String } ``` ### YAML ``` [DatetimeTypeFieldName](#cfn-appflow-flow-incrementalpullconfig-datetimetypefieldname): String ``` ## Properties `DatetimeTypeFieldName` A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source. *Required*: No *Type*: String *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow InforNexusSourceProperties The properties that are applied when Infor Nexus is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-infornexussourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-infornexussourceproperties-object): String ``` ## Properties `Object` The object specified in the Infor Nexus flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [InforNexusSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_InforNexusSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow LookoutMetricsDestinationProperties The properties that are applied when Amazon Lookout for Metrics is used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-lookoutmetricsdestinationproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-lookoutmetricsdestinationproperties-object): String ``` ## Properties `Object` The object specified in the Amazon Lookout for Metrics flow destination. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow MarketoDestinationProperties The properties that Amazon AppFlow applies when you use Marketo as a flow destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ErrorHandlingConfig](#cfn-appflow-flow-marketodestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[Object](#cfn-appflow-flow-marketodestinationproperties-object)" : String } ``` ### YAML ``` [ErrorHandlingConfig](#cfn-appflow-flow-marketodestinationproperties-errorhandlingconfig): ErrorHandlingConfig [Object](#cfn-appflow-flow-marketodestinationproperties-object): String ``` ## Properties `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Marketo flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow MarketoSourceProperties The properties that are applied when Marketo is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-marketosourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-marketosourceproperties-object): String ``` ## Properties `Object` The object specified in the Marketo flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [MarketoSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_MarketoSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow MetadataCatalogConfig Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GlueDataCatalog](#cfn-appflow-flow-metadatacatalogconfig-gluedatacatalog)" : GlueDataCatalog } ``` ### YAML ``` [GlueDataCatalog](#cfn-appflow-flow-metadatacatalogconfig-gluedatacatalog): GlueDataCatalog ``` ## Properties `GlueDataCatalog` Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the AWS Glue Data Catalog. *Required*: No *Type*: [GlueDataCatalog](aws-properties-appflow-flow-gluedatacatalog.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow PardotSourceProperties The properties that are applied when Salesforce Pardot is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-pardotsourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-pardotsourceproperties-object): String ``` ## Properties `Object` The object specified in the Salesforce Pardot flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow PrefixConfig Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PathPrefixHierarchy](#cfn-appflow-flow-prefixconfig-pathprefixhierarchy)" : [ String, ... ], "[PrefixFormat](#cfn-appflow-flow-prefixconfig-prefixformat)" : String, "[PrefixType](#cfn-appflow-flow-prefixconfig-prefixtype)" : String } ``` ### YAML ``` [PathPrefixHierarchy](#cfn-appflow-flow-prefixconfig-pathprefixhierarchy): - String [PrefixFormat](#cfn-appflow-flow-prefixconfig-prefixformat): String [PrefixType](#cfn-appflow-flow-prefixconfig-prefixtype): String ``` ## Properties `PathPrefixHierarchy` Specifies whether the destination file path includes either or both of the following elements: EXECUTION\$1ID The ID that Amazon AppFlow assigns to the flow run. SCHEMA\$1VERSION The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration: + Source-to-destination field mappings + Field data types + Partition keys *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrefixFormat` Determines the level of granularity for the date and time that's included in the prefix. *Required*: No *Type*: String *Allowed values*: `YEAR | MONTH | DAY | HOUR | MINUTE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrefixType` Determines the format of the prefix, and whether it applies to the file name, file path, or both. *Required*: No *Type*: String *Allowed values*: `FILENAME | PATH | PATH_AND_FILENAME` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [PrefixConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_PrefixConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow RedshiftDestinationProperties The properties that are applied when Amazon Redshift is being used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketPrefix](#cfn-appflow-flow-redshiftdestinationproperties-bucketprefix)" : String, "[ErrorHandlingConfig](#cfn-appflow-flow-redshiftdestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IntermediateBucketName](#cfn-appflow-flow-redshiftdestinationproperties-intermediatebucketname)" : String, "[Object](#cfn-appflow-flow-redshiftdestinationproperties-object)" : String } ``` ### YAML ``` [BucketPrefix](#cfn-appflow-flow-redshiftdestinationproperties-bucketprefix): String [ErrorHandlingConfig](#cfn-appflow-flow-redshiftdestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IntermediateBucketName](#cfn-appflow-flow-redshiftdestinationproperties-intermediatebucketname): String [Object](#cfn-appflow-flow-redshiftdestinationproperties-object): String ``` ## Properties `BucketPrefix` The object key for the bucket in which Amazon AppFlow places the destination files. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntermediateBucketName` The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Amazon Redshift flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [RedshiftDestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_RedshiftDestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow S3DestinationProperties The properties that are applied when Amazon S3 is used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-flow-s3destinationproperties-bucketname)" : String, "[BucketPrefix](#cfn-appflow-flow-s3destinationproperties-bucketprefix)" : String, "[S3OutputFormatConfig](#cfn-appflow-flow-s3destinationproperties-s3outputformatconfig)" : S3OutputFormatConfig } ``` ### YAML ``` [BucketName](#cfn-appflow-flow-s3destinationproperties-bucketname): String [BucketPrefix](#cfn-appflow-flow-s3destinationproperties-bucketprefix): String [S3OutputFormatConfig](#cfn-appflow-flow-s3destinationproperties-s3outputformatconfig): S3OutputFormatConfig ``` ## Properties `BucketName` The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The object key for the destination bucket in which Amazon AppFlow places the files. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3OutputFormatConfig` The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination. *Required*: No *Type*: [S3OutputFormatConfig](aws-properties-appflow-flow-s3outputformatconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [S3DestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_S3DestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow S3InputFormatConfig When you use Amazon S3 as the source, the configuration format that you provide the flow input data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3InputFileType](#cfn-appflow-flow-s3inputformatconfig-s3inputfiletype)" : String } ``` ### YAML ``` [S3InputFileType](#cfn-appflow-flow-s3inputformatconfig-s3inputfiletype): String ``` ## Properties `S3InputFileType` The file type that Amazon AppFlow gets from your Amazon S3 bucket. *Required*: No *Type*: String *Allowed values*: `CSV | JSON` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow S3OutputFormatConfig The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregationConfig](#cfn-appflow-flow-s3outputformatconfig-aggregationconfig)" : AggregationConfig, "[FileType](#cfn-appflow-flow-s3outputformatconfig-filetype)" : String, "[PrefixConfig](#cfn-appflow-flow-s3outputformatconfig-prefixconfig)" : PrefixConfig, "[PreserveSourceDataTyping](#cfn-appflow-flow-s3outputformatconfig-preservesourcedatatyping)" : Boolean } ``` ### YAML ``` [AggregationConfig](#cfn-appflow-flow-s3outputformatconfig-aggregationconfig): AggregationConfig [FileType](#cfn-appflow-flow-s3outputformatconfig-filetype): String [PrefixConfig](#cfn-appflow-flow-s3outputformatconfig-prefixconfig): PrefixConfig [PreserveSourceDataTyping](#cfn-appflow-flow-s3outputformatconfig-preservesourcedatatyping): Boolean ``` ## Properties `AggregationConfig` The aggregation settings that you can use to customize the output format of your flow data. *Required*: No *Type*: [AggregationConfig](aws-properties-appflow-flow-aggregationconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FileType` Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. *Required*: No *Type*: String *Allowed values*: `CSV | JSON | PARQUET` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrefixConfig` Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date. *Required*: No *Type*: [PrefixConfig](aws-properties-appflow-flow-prefixconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreserveSourceDataTyping` If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3. + `true`: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or `1` in your source data is still an integer in your output. + `false`: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of `1` in your source data becomes the string `"1"` in the output. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [S3OutputFormatConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_S3OutputFormatConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow S3SourceProperties The properties that are applied when Amazon S3 is being used as the flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-flow-s3sourceproperties-bucketname)" : String, "[BucketPrefix](#cfn-appflow-flow-s3sourceproperties-bucketprefix)" : String, "[S3InputFormatConfig](#cfn-appflow-flow-s3sourceproperties-s3inputformatconfig)" : S3InputFormatConfig } ``` ### YAML ``` [BucketName](#cfn-appflow-flow-s3sourceproperties-bucketname): String [BucketPrefix](#cfn-appflow-flow-s3sourceproperties-bucketprefix): String [S3InputFormatConfig](#cfn-appflow-flow-s3sourceproperties-s3inputformatconfig): S3InputFormatConfig ``` ## Properties `BucketName` The Amazon S3 bucket name where the source files are stored. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The object key for the Amazon S3 bucket in which the source files are stored. *Required*: Yes *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3InputFormatConfig` When you use Amazon S3 as the source, the configuration format that you provide the flow input data. *Required*: No *Type*: [S3InputFormatConfig](aws-properties-appflow-flow-s3inputformatconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [S3SourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_S3SourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SalesforceDestinationProperties The properties that are applied when Salesforce is being used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataTransferApi](#cfn-appflow-flow-salesforcedestinationproperties-datatransferapi)" : String, "[ErrorHandlingConfig](#cfn-appflow-flow-salesforcedestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IdFieldNames](#cfn-appflow-flow-salesforcedestinationproperties-idfieldnames)" : [ String, ... ], "[Object](#cfn-appflow-flow-salesforcedestinationproperties-object)" : String, "[WriteOperationType](#cfn-appflow-flow-salesforcedestinationproperties-writeoperationtype)" : String } ``` ### YAML ``` [DataTransferApi](#cfn-appflow-flow-salesforcedestinationproperties-datatransferapi): String [ErrorHandlingConfig](#cfn-appflow-flow-salesforcedestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IdFieldNames](#cfn-appflow-flow-salesforcedestinationproperties-idfieldnames): - String [Object](#cfn-appflow-flow-salesforcedestinationproperties-object): String [WriteOperationType](#cfn-appflow-flow-salesforcedestinationproperties-writeoperationtype): String ``` ## Properties `DataTransferApi` Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce. AUTOMATIC The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output. BULKV2 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers. Note that Bulk API 2.0 does not transfer Salesforce compound fields. REST\$1SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error. *Required*: No *Type*: [String](aws-properties-appflow-flow-datatransferapi.md) *Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdFieldNames` The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete. *Required*: No *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Salesforce flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WriteOperationType` This specifies the type of write operation to be performed in Salesforce. When the value is `UPSERT`, then `idFieldNames` is required. *Required*: No *Type*: String *Allowed values*: `INSERT | UPSERT | UPDATE | DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SalesforceDestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SalesforceDestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SalesforceSourceProperties The properties that are applied when Salesforce is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataTransferApi](#cfn-appflow-flow-salesforcesourceproperties-datatransferapi)" : String, "[EnableDynamicFieldUpdate](#cfn-appflow-flow-salesforcesourceproperties-enabledynamicfieldupdate)" : Boolean, "[IncludeDeletedRecords](#cfn-appflow-flow-salesforcesourceproperties-includedeletedrecords)" : Boolean, "[Object](#cfn-appflow-flow-salesforcesourceproperties-object)" : String } ``` ### YAML ``` [DataTransferApi](#cfn-appflow-flow-salesforcesourceproperties-datatransferapi): String [EnableDynamicFieldUpdate](#cfn-appflow-flow-salesforcesourceproperties-enabledynamicfieldupdate): Boolean [IncludeDeletedRecords](#cfn-appflow-flow-salesforcesourceproperties-includedeletedrecords): Boolean [Object](#cfn-appflow-flow-salesforcesourceproperties-object): String ``` ## Properties `DataTransferApi` Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. AUTOMATIC The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output. BULKV2 Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers. Note that Bulk API 2.0 does not transfer Salesforce compound fields. REST\$1SYNC Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *Required*: No *Type*: [String](aws-properties-appflow-flow-datatransferapi.md) *Allowed values*: `AUTOMATIC | BULKV2 | REST_SYNC` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnableDynamicFieldUpdate` The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeDeletedRecords` Indicates whether Amazon AppFlow includes deleted files in the flow run. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Salesforce flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SalesforceSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SalesforceSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SAPODataDestinationProperties The properties that are applied when using SAPOData as a flow destination ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ErrorHandlingConfig](#cfn-appflow-flow-sapodatadestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IdFieldNames](#cfn-appflow-flow-sapodatadestinationproperties-idfieldnames)" : [ String, ... ], "[ObjectPath](#cfn-appflow-flow-sapodatadestinationproperties-objectpath)" : String, "[SuccessResponseHandlingConfig](#cfn-appflow-flow-sapodatadestinationproperties-successresponsehandlingconfig)" : SuccessResponseHandlingConfig, "[WriteOperationType](#cfn-appflow-flow-sapodatadestinationproperties-writeoperationtype)" : String } ``` ### YAML ``` [ErrorHandlingConfig](#cfn-appflow-flow-sapodatadestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IdFieldNames](#cfn-appflow-flow-sapodatadestinationproperties-idfieldnames): - String [ObjectPath](#cfn-appflow-flow-sapodatadestinationproperties-objectpath): String [SuccessResponseHandlingConfig](#cfn-appflow-flow-sapodatadestinationproperties-successresponsehandlingconfig): SuccessResponseHandlingConfig [WriteOperationType](#cfn-appflow-flow-sapodatadestinationproperties-writeoperationtype): String ``` ## Properties `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdFieldNames` A list of field names that can be used as an ID field when performing a write operation. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectPath` The object path specified in the SAPOData flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SuccessResponseHandlingConfig` Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. For example, this setting would determine where to write the response from a destination connector upon a successful insert operation. *Required*: No *Type*: [SuccessResponseHandlingConfig](aws-properties-appflow-flow-successresponsehandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WriteOperationType` The possible write operations in the destination connector. When this value is not provided, this defaults to the `INSERT` operation. *Required*: No *Type*: String *Allowed values*: `INSERT | UPSERT | UPDATE | DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow SAPODataPaginationConfig Sets the page size for each *concurrent process* that transfers OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[maxPageSize](#cfn-appflow-flow-sapodatapaginationconfig-maxpagesize)" : Integer } ``` ### YAML ``` [maxPageSize](#cfn-appflow-flow-sapodatapaginationconfig-maxpagesize): Integer ``` ## Properties `maxPageSize` The maximum number of records that Amazon AppFlow receives in each page of the response from your SAP application. For transfers of OData records, the maximum page size is 3,000. For transfers of data that comes from an ODP provider, the maximum page size is 10,000. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `10000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow SAPODataParallelismConfig Sets the number of *concurrent processes* that transfer OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[maxParallelism](#cfn-appflow-flow-sapodataparallelismconfig-maxparallelism)" : Integer } ``` ### YAML ``` [maxParallelism](#cfn-appflow-flow-sapodataparallelismconfig-maxparallelism): Integer ``` ## Properties `maxParallelism` The maximum number of processes that Amazon AppFlow runs at the same time when it retrieves your data from your SAP application. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow SAPODataSourceProperties The properties that are applied when using SAPOData as a flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ObjectPath](#cfn-appflow-flow-sapodatasourceproperties-objectpath)" : String, "[paginationConfig](#cfn-appflow-flow-sapodatasourceproperties-paginationconfig)" : SAPODataPaginationConfig, "[parallelismConfig](#cfn-appflow-flow-sapodatasourceproperties-parallelismconfig)" : SAPODataParallelismConfig } ``` ### YAML ``` [ObjectPath](#cfn-appflow-flow-sapodatasourceproperties-objectpath): String [paginationConfig](#cfn-appflow-flow-sapodatasourceproperties-paginationconfig): SAPODataPaginationConfig [parallelismConfig](#cfn-appflow-flow-sapodatasourceproperties-parallelismconfig): SAPODataParallelismConfig ``` ## Properties `ObjectPath` The object path specified in the SAPOData flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `paginationConfig` Sets the page size for each concurrent process that transfers OData records from your SAP instance. *Required*: No *Type*: [SAPODataPaginationConfig](aws-properties-appflow-flow-sapodatapaginationconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `parallelismConfig` Sets the number of concurrent processes that transfers OData records from your SAP instance. *Required*: No *Type*: [SAPODataParallelismConfig](aws-properties-appflow-flow-sapodataparallelismconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow ScheduledTriggerProperties Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the `Scheduled` trigger type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataPullMode](#cfn-appflow-flow-scheduledtriggerproperties-datapullmode)" : String, "[FirstExecutionFrom](#cfn-appflow-flow-scheduledtriggerproperties-firstexecutionfrom)" : Number, "[FlowErrorDeactivationThreshold](#cfn-appflow-flow-scheduledtriggerproperties-flowerrordeactivationthreshold)" : Integer, "[ScheduleEndTime](#cfn-appflow-flow-scheduledtriggerproperties-scheduleendtime)" : Number, "[ScheduleExpression](#cfn-appflow-flow-scheduledtriggerproperties-scheduleexpression)" : String, "[ScheduleOffset](#cfn-appflow-flow-scheduledtriggerproperties-scheduleoffset)" : Number, "[ScheduleStartTime](#cfn-appflow-flow-scheduledtriggerproperties-schedulestarttime)" : Number, "[TimeZone](#cfn-appflow-flow-scheduledtriggerproperties-timezone)" : String } ``` ### YAML ``` [DataPullMode](#cfn-appflow-flow-scheduledtriggerproperties-datapullmode): String [FirstExecutionFrom](#cfn-appflow-flow-scheduledtriggerproperties-firstexecutionfrom): Number [FlowErrorDeactivationThreshold](#cfn-appflow-flow-scheduledtriggerproperties-flowerrordeactivationthreshold): Integer [ScheduleEndTime](#cfn-appflow-flow-scheduledtriggerproperties-scheduleendtime): Number [ScheduleExpression](#cfn-appflow-flow-scheduledtriggerproperties-scheduleexpression): String [ScheduleOffset](#cfn-appflow-flow-scheduledtriggerproperties-scheduleoffset): Number [ScheduleStartTime](#cfn-appflow-flow-scheduledtriggerproperties-schedulestarttime): Number [TimeZone](#cfn-appflow-flow-scheduledtriggerproperties-timezone): String ``` ## Properties `DataPullMode` Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. *Required*: No *Type*: String *Allowed values*: `Incremental | Complete` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FirstExecutionFrom` Specifies the date range for the records to import from the connector in the first flow run. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FlowErrorDeactivationThreshold` Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleEndTime` The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-27T13:00:00-07:00`. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleExpression` The scheduling expression that determines the rate at which the schedule will run, for example `rate(5minutes)`. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleOffset` Specifies the optional offset that is added to the time interval for a schedule-triggered flow. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `36000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleStartTime` The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as `2022-04-26T13:00:00-07:00`. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TimeZone` Specifies the time zone used when referring to the dates and times of a scheduled flow, such as `America/New_York`. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow. If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the `America/New_York` timezone are `-04:00` EDT and `-05:00 EST`. *Required*: No *Type*: String *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ScheduledTriggerProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ScheduledTriggerProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow ServiceNowSourceProperties The properties that are applied when ServiceNow is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-servicenowsourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-servicenowsourceproperties-object): String ``` ## Properties `Object` The object specified in the ServiceNow flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ServiceNowSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ServiceNowSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SingularSourceProperties The properties that are applied when Singular is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-singularsourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-singularsourceproperties-object): String ``` ## Properties `Object` The object specified in the Singular flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SingularSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SingularSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SlackSourceProperties The properties that are applied when Slack is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-slacksourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-slacksourceproperties-object): String ``` ## Properties `Object` The object specified in the Slack flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SlackSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SlackSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SnowflakeDestinationProperties The properties that are applied when Snowflake is being used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketPrefix](#cfn-appflow-flow-snowflakedestinationproperties-bucketprefix)" : String, "[ErrorHandlingConfig](#cfn-appflow-flow-snowflakedestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IntermediateBucketName](#cfn-appflow-flow-snowflakedestinationproperties-intermediatebucketname)" : String, "[Object](#cfn-appflow-flow-snowflakedestinationproperties-object)" : String } ``` ### YAML ``` [BucketPrefix](#cfn-appflow-flow-snowflakedestinationproperties-bucketprefix): String [ErrorHandlingConfig](#cfn-appflow-flow-snowflakedestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IntermediateBucketName](#cfn-appflow-flow-snowflakedestinationproperties-intermediatebucketname): String [Object](#cfn-appflow-flow-snowflakedestinationproperties-object): String ``` ## Properties `BucketPrefix` The object key for the destination bucket in which Amazon AppFlow places the files. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IntermediateBucketName` The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Snowflake flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SnowflakeDestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SnowflakeDestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SourceConnectorProperties Specifies the information that is required to query a particular connector. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Amplitude](#cfn-appflow-flow-sourceconnectorproperties-amplitude)" : AmplitudeSourceProperties, "[CustomConnector](#cfn-appflow-flow-sourceconnectorproperties-customconnector)" : CustomConnectorSourceProperties, "[Datadog](#cfn-appflow-flow-sourceconnectorproperties-datadog)" : DatadogSourceProperties, "[Dynatrace](#cfn-appflow-flow-sourceconnectorproperties-dynatrace)" : DynatraceSourceProperties, "[GoogleAnalytics](#cfn-appflow-flow-sourceconnectorproperties-googleanalytics)" : GoogleAnalyticsSourceProperties, "[InforNexus](#cfn-appflow-flow-sourceconnectorproperties-infornexus)" : InforNexusSourceProperties, "[Marketo](#cfn-appflow-flow-sourceconnectorproperties-marketo)" : MarketoSourceProperties, "[Pardot](#cfn-appflow-flow-sourceconnectorproperties-pardot)" : PardotSourceProperties, "[S3](#cfn-appflow-flow-sourceconnectorproperties-s3)" : S3SourceProperties, "[Salesforce](#cfn-appflow-flow-sourceconnectorproperties-salesforce)" : SalesforceSourceProperties, "[SAPOData](#cfn-appflow-flow-sourceconnectorproperties-sapodata)" : SAPODataSourceProperties, "[ServiceNow](#cfn-appflow-flow-sourceconnectorproperties-servicenow)" : ServiceNowSourceProperties, "[Singular](#cfn-appflow-flow-sourceconnectorproperties-singular)" : SingularSourceProperties, "[Slack](#cfn-appflow-flow-sourceconnectorproperties-slack)" : SlackSourceProperties, "[Trendmicro](#cfn-appflow-flow-sourceconnectorproperties-trendmicro)" : TrendmicroSourceProperties, "[Veeva](#cfn-appflow-flow-sourceconnectorproperties-veeva)" : VeevaSourceProperties, "[Zendesk](#cfn-appflow-flow-sourceconnectorproperties-zendesk)" : ZendeskSourceProperties } ``` ### YAML ``` [Amplitude](#cfn-appflow-flow-sourceconnectorproperties-amplitude): AmplitudeSourceProperties [CustomConnector](#cfn-appflow-flow-sourceconnectorproperties-customconnector): CustomConnectorSourceProperties [Datadog](#cfn-appflow-flow-sourceconnectorproperties-datadog): DatadogSourceProperties [Dynatrace](#cfn-appflow-flow-sourceconnectorproperties-dynatrace): DynatraceSourceProperties [GoogleAnalytics](#cfn-appflow-flow-sourceconnectorproperties-googleanalytics): GoogleAnalyticsSourceProperties [InforNexus](#cfn-appflow-flow-sourceconnectorproperties-infornexus): InforNexusSourceProperties [Marketo](#cfn-appflow-flow-sourceconnectorproperties-marketo): MarketoSourceProperties [Pardot](#cfn-appflow-flow-sourceconnectorproperties-pardot): PardotSourceProperties [S3](#cfn-appflow-flow-sourceconnectorproperties-s3): S3SourceProperties [Salesforce](#cfn-appflow-flow-sourceconnectorproperties-salesforce): SalesforceSourceProperties [SAPOData](#cfn-appflow-flow-sourceconnectorproperties-sapodata): SAPODataSourceProperties [ServiceNow](#cfn-appflow-flow-sourceconnectorproperties-servicenow): ServiceNowSourceProperties [Singular](#cfn-appflow-flow-sourceconnectorproperties-singular): SingularSourceProperties [Slack](#cfn-appflow-flow-sourceconnectorproperties-slack): SlackSourceProperties [Trendmicro](#cfn-appflow-flow-sourceconnectorproperties-trendmicro): TrendmicroSourceProperties [Veeva](#cfn-appflow-flow-sourceconnectorproperties-veeva): VeevaSourceProperties [Zendesk](#cfn-appflow-flow-sourceconnectorproperties-zendesk): ZendeskSourceProperties ``` ## Properties `Amplitude` Specifies the information that is required for querying Amplitude. *Required*: No *Type*: [AmplitudeSourceProperties](aws-properties-appflow-flow-amplitudesourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomConnector` The properties that are applied when the custom connector is being used as a source. *Required*: No *Type*: [CustomConnectorSourceProperties](aws-properties-appflow-flow-customconnectorsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Datadog` Specifies the information that is required for querying Datadog. *Required*: No *Type*: [DatadogSourceProperties](aws-properties-appflow-flow-datadogsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Dynatrace` Specifies the information that is required for querying Dynatrace. *Required*: No *Type*: [DynatraceSourceProperties](aws-properties-appflow-flow-dynatracesourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GoogleAnalytics` Specifies the information that is required for querying Google Analytics. *Required*: No *Type*: [GoogleAnalyticsSourceProperties](aws-properties-appflow-flow-googleanalyticssourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InforNexus` Specifies the information that is required for querying Infor Nexus. *Required*: No *Type*: [InforNexusSourceProperties](aws-properties-appflow-flow-infornexussourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Marketo` Specifies the information that is required for querying Marketo. *Required*: No *Type*: [MarketoSourceProperties](aws-properties-appflow-flow-marketosourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pardot` Specifies the information that is required for querying Salesforce Pardot. *Required*: No *Type*: [PardotSourceProperties](aws-properties-appflow-flow-pardotsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` Specifies the information that is required for querying Amazon S3. *Required*: No *Type*: [S3SourceProperties](aws-properties-appflow-flow-s3sourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` Specifies the information that is required for querying Salesforce. *Required*: No *Type*: [SalesforceSourceProperties](aws-properties-appflow-flow-salesforcesourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SAPOData` The properties that are applied when using SAPOData as a flow source. *Required*: No *Type*: [SAPODataSourceProperties](aws-properties-appflow-flow-sapodatasourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` Specifies the information that is required for querying ServiceNow. *Required*: No *Type*: [ServiceNowSourceProperties](aws-properties-appflow-flow-servicenowsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Singular` Specifies the information that is required for querying Singular. *Required*: No *Type*: [SingularSourceProperties](aws-properties-appflow-flow-singularsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Slack` Specifies the information that is required for querying Slack. *Required*: No *Type*: [SlackSourceProperties](aws-properties-appflow-flow-slacksourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Trendmicro` Specifies the information that is required for querying Trend Micro. *Required*: No *Type*: [TrendmicroSourceProperties](aws-properties-appflow-flow-trendmicrosourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Veeva` Specifies the information that is required for querying Veeva. *Required*: No *Type*: [VeevaSourceProperties](aws-properties-appflow-flow-veevasourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` Specifies the information that is required for querying Zendesk. *Required*: No *Type*: [ZendeskSourceProperties](aws-properties-appflow-flow-zendesksourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SourceConnectorProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SourceConnectorProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SourceFlowConfig Contains information about the configuration of the source connector used in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApiVersion](#cfn-appflow-flow-sourceflowconfig-apiversion)" : String, "[ConnectorProfileName](#cfn-appflow-flow-sourceflowconfig-connectorprofilename)" : String, "[ConnectorType](#cfn-appflow-flow-sourceflowconfig-connectortype)" : String, "[IncrementalPullConfig](#cfn-appflow-flow-sourceflowconfig-incrementalpullconfig)" : IncrementalPullConfig, "[SourceConnectorProperties](#cfn-appflow-flow-sourceflowconfig-sourceconnectorproperties)" : SourceConnectorProperties } ``` ### YAML ``` [ApiVersion](#cfn-appflow-flow-sourceflowconfig-apiversion): String [ConnectorProfileName](#cfn-appflow-flow-sourceflowconfig-connectorprofilename): String [ConnectorType](#cfn-appflow-flow-sourceflowconfig-connectortype): String [IncrementalPullConfig](#cfn-appflow-flow-sourceflowconfig-incrementalpullconfig): IncrementalPullConfig [SourceConnectorProperties](#cfn-appflow-flow-sourceflowconfig-sourceconnectorproperties): SourceConnectorProperties ``` ## Properties `ApiVersion` The API version of the connector when it's used as a source in the flow. *Required*: No *Type*: String *Pattern*: `\S+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorProfileName` The name of the connector profile. This name must be unique for each connector profile in the AWS account. *Required*: No *Type*: String *Pattern*: `[\w/!@#+=.-]+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorType` The type of connector, such as Salesforce, Amplitude, and so on. *Required*: Yes *Type*: String *Allowed values*: `SAPOData | Salesforce | Pardot | Singular | Slack | Redshift | S3 | Marketo | Googleanalytics | Zendesk | Servicenow | Datadog | Trendmicro | Snowflake | Dynatrace | Infornexus | Amplitude | Veeva | CustomConnector | EventBridge | Upsolver | LookoutMetrics` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncrementalPullConfig` Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull. *Required*: No *Type*: [IncrementalPullConfig](aws-properties-appflow-flow-incrementalpullconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConnectorProperties` Specifies the information that is required to query a particular source connector. *Required*: Yes *Type*: [SourceConnectorProperties](aws-properties-appflow-flow-sourceconnectorproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [SourceFlowConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_SourceFlowConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow SuccessResponseHandlingConfig Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. For example, this setting would determine where to write the response from the destination connector upon a successful insert operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-flow-successresponsehandlingconfig-bucketname)" : String, "[BucketPrefix](#cfn-appflow-flow-successresponsehandlingconfig-bucketprefix)" : String } ``` ### YAML ``` [BucketName](#cfn-appflow-flow-successresponsehandlingconfig-bucketname): String [BucketPrefix](#cfn-appflow-flow-successresponsehandlingconfig-bucketprefix): String ``` ## Properties `BucketName` The name of the Amazon S3 bucket. *Required*: No *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The Amazon S3 bucket prefix. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow Tag The `Tag` property type specifies Property description not available. for an [AWS::AppFlow::Flow](aws-resource-appflow-flow.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-appflow-flow-tag-key)" : String, "[Value](#cfn-appflow-flow-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-appflow-flow-tag-key): String [Value](#cfn-appflow-flow-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow Task A class for modeling different type of tasks. Task implementation varies based on the `TaskType`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConnectorOperator](#cfn-appflow-flow-task-connectoroperator)" : ConnectorOperator, "[DestinationField](#cfn-appflow-flow-task-destinationfield)" : String, "[SourceFields](#cfn-appflow-flow-task-sourcefields)" : [ String, ... ], "[TaskProperties](#cfn-appflow-flow-task-taskproperties)" : [ TaskPropertiesObject, ... ], "[TaskType](#cfn-appflow-flow-task-tasktype)" : String } ``` ### YAML ``` [ConnectorOperator](#cfn-appflow-flow-task-connectoroperator): ConnectorOperator [DestinationField](#cfn-appflow-flow-task-destinationfield): String [SourceFields](#cfn-appflow-flow-task-sourcefields): - String [TaskProperties](#cfn-appflow-flow-task-taskproperties): - TaskPropertiesObject [TaskType](#cfn-appflow-flow-task-tasktype): String ``` ## Properties `ConnectorOperator` The operation to be performed on the provided source fields. *Required*: No *Type*: [ConnectorOperator](aws-properties-appflow-flow-connectoroperator.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationField` A field in a destination connector, or a field value against which Amazon AppFlow validates a source field. *Required*: No *Type*: String *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceFields` The source fields to which a particular task is applied. *Required*: Yes *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskProperties` A map used to store task-related information. The execution service looks for particular information based on the `TaskType`. *Required*: No *Type*: Array of [TaskPropertiesObject](aws-properties-appflow-flow-taskpropertiesobject.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskType` Specifies the particular task implementation that Amazon AppFlow performs. *Allowed values*: `Arithmetic` \$1 `Filter` \$1 `Map` \$1 `Map_all` \$1 `Mask` \$1 `Merge` \$1 `Truncate` \$1 `Validate` *Required*: Yes *Type*: String *Allowed values*: `Arithmetic | Filter | Map | Map_all | Mask | Merge | Passthrough | Truncate | Validate | Partition` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [Task](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Task.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow TaskPropertiesObject A map used to store task-related information. The execution service looks for particular information based on the `TaskType`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-appflow-flow-taskpropertiesobject-key)" : String, "[Value](#cfn-appflow-flow-taskpropertiesobject-value)" : String } ``` ### YAML ``` [Key](#cfn-appflow-flow-taskpropertiesobject-key): String [Value](#cfn-appflow-flow-taskpropertiesobject-value): String ``` ## Properties `Key` The task property key. *Required*: Yes *Type*: String *Allowed values*: `VALUE | VALUES | DATA_TYPE | UPPER_BOUND | LOWER_BOUND | SOURCE_DATA_TYPE | DESTINATION_DATA_TYPE | VALIDATION_ACTION | MASK_VALUE | MASK_LENGTH | TRUNCATE_LENGTH | MATH_OPERATION_FIELDS_ORDER | CONCAT_FORMAT | SUBFIELD_CATEGORY_MAP | EXCLUDE_SOURCE_FIELDS_LIST | INCLUDE_NEW_FIELDS | ORDERED_PARTITION_KEYS_LIST` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The task property value. *Required*: Yes *Type*: String *Pattern*: `.+` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow TrendmicroSourceProperties The properties that are applied when using Trend Micro as a flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-trendmicrosourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-trendmicrosourceproperties-object): String ``` ## Properties `Object` The object specified in the Trend Micro flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [TrendmicroSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_TrendmicroSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow TriggerConfig The trigger settings that determine how and when Amazon AppFlow runs the specified flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TriggerProperties](#cfn-appflow-flow-triggerconfig-triggerproperties)" : ScheduledTriggerProperties, "[TriggerType](#cfn-appflow-flow-triggerconfig-triggertype)" : String } ``` ### YAML ``` [TriggerProperties](#cfn-appflow-flow-triggerconfig-triggerproperties): ScheduledTriggerProperties [TriggerType](#cfn-appflow-flow-triggerconfig-triggertype): String ``` ## Properties `TriggerProperties` Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the `Scheduled` trigger type. *Required*: No *Type*: [ScheduledTriggerProperties](aws-properties-appflow-flow-scheduledtriggerproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TriggerType` Specifies the type of flow trigger. This can be `OnDemand`, `Scheduled`, or `Event`. *Required*: Yes *Type*: String *Allowed values*: `Scheduled | Event | OnDemand` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [TriggerConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_TriggerConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow UpsolverDestinationProperties The properties that are applied when Upsolver is used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-appflow-flow-upsolverdestinationproperties-bucketname)" : String, "[BucketPrefix](#cfn-appflow-flow-upsolverdestinationproperties-bucketprefix)" : String, "[S3OutputFormatConfig](#cfn-appflow-flow-upsolverdestinationproperties-s3outputformatconfig)" : UpsolverS3OutputFormatConfig } ``` ### YAML ``` [BucketName](#cfn-appflow-flow-upsolverdestinationproperties-bucketname): String [BucketPrefix](#cfn-appflow-flow-upsolverdestinationproperties-bucketprefix): String [S3OutputFormatConfig](#cfn-appflow-flow-upsolverdestinationproperties-s3outputformatconfig): UpsolverS3OutputFormatConfig ``` ## Properties `BucketName` The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data. *Required*: Yes *Type*: String *Pattern*: `^(upsolver-appflow)\S*` *Minimum*: `16` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files. *Required*: No *Type*: String *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3OutputFormatConfig` The configuration that determines how data is formatted when Upsolver is used as the flow destination. *Required*: Yes *Type*: [UpsolverS3OutputFormatConfig](aws-properties-appflow-flow-upsolvers3outputformatconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [UpsolverDestinationProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_UpsolverDestinationProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow UpsolverS3OutputFormatConfig The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AggregationConfig](#cfn-appflow-flow-upsolvers3outputformatconfig-aggregationconfig)" : AggregationConfig, "[FileType](#cfn-appflow-flow-upsolvers3outputformatconfig-filetype)" : String, "[PrefixConfig](#cfn-appflow-flow-upsolvers3outputformatconfig-prefixconfig)" : PrefixConfig } ``` ### YAML ``` [AggregationConfig](#cfn-appflow-flow-upsolvers3outputformatconfig-aggregationconfig): AggregationConfig [FileType](#cfn-appflow-flow-upsolvers3outputformatconfig-filetype): String [PrefixConfig](#cfn-appflow-flow-upsolvers3outputformatconfig-prefixconfig): PrefixConfig ``` ## Properties `AggregationConfig` The aggregation settings that you can use to customize the output format of your flow data. *Required*: No *Type*: [AggregationConfig](aws-properties-appflow-flow-aggregationconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FileType` Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket. *Required*: No *Type*: String *Allowed values*: `CSV | JSON | PARQUET` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PrefixConfig` Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination. *Required*: Yes *Type*: [PrefixConfig](aws-properties-appflow-flow-prefixconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [UpsolverS3OutputFormatConfig](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_UpsolverS3OutputFormatConfig.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow VeevaSourceProperties The properties that are applied when using Veeva as a flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DocumentType](#cfn-appflow-flow-veevasourceproperties-documenttype)" : String, "[IncludeAllVersions](#cfn-appflow-flow-veevasourceproperties-includeallversions)" : Boolean, "[IncludeRenditions](#cfn-appflow-flow-veevasourceproperties-includerenditions)" : Boolean, "[IncludeSourceFiles](#cfn-appflow-flow-veevasourceproperties-includesourcefiles)" : Boolean, "[Object](#cfn-appflow-flow-veevasourceproperties-object)" : String } ``` ### YAML ``` [DocumentType](#cfn-appflow-flow-veevasourceproperties-documenttype): String [IncludeAllVersions](#cfn-appflow-flow-veevasourceproperties-includeallversions): Boolean [IncludeRenditions](#cfn-appflow-flow-veevasourceproperties-includerenditions): Boolean [IncludeSourceFiles](#cfn-appflow-flow-veevasourceproperties-includesourcefiles): Boolean [Object](#cfn-appflow-flow-veevasourceproperties-object): String ``` ## Properties `DocumentType` The document type specified in the Veeva document extract flow. *Required*: No *Type*: String *Pattern*: `[\s\w_-]+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeAllVersions` Boolean value to include All Versions of files in Veeva document extract flow. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeRenditions` Boolean value to include file renditions in Veeva document extract flow. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeSourceFiles` Boolean value to include source files in Veeva document extract flow. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Veeva flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [VeevaSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_VeevaSourceProperties.html) in the *Amazon AppFlow API Reference*. # AWS::AppFlow::Flow ZendeskDestinationProperties The properties that are applied when Zendesk is used as a destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ErrorHandlingConfig](#cfn-appflow-flow-zendeskdestinationproperties-errorhandlingconfig)" : ErrorHandlingConfig, "[IdFieldNames](#cfn-appflow-flow-zendeskdestinationproperties-idfieldnames)" : [ String, ... ], "[Object](#cfn-appflow-flow-zendeskdestinationproperties-object)" : String, "[WriteOperationType](#cfn-appflow-flow-zendeskdestinationproperties-writeoperationtype)" : String } ``` ### YAML ``` [ErrorHandlingConfig](#cfn-appflow-flow-zendeskdestinationproperties-errorhandlingconfig): ErrorHandlingConfig [IdFieldNames](#cfn-appflow-flow-zendeskdestinationproperties-idfieldnames): - String [Object](#cfn-appflow-flow-zendeskdestinationproperties-object): String [WriteOperationType](#cfn-appflow-flow-zendeskdestinationproperties-writeoperationtype): String ``` ## Properties `ErrorHandlingConfig` The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. `ErrorHandlingConfig` is a part of the destination connector details. *Required*: No *Type*: [ErrorHandlingConfig](aws-properties-appflow-flow-errorhandlingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdFieldNames` A list of field names that can be used as an ID field when performing a write operation. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Zendesk flow destination. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WriteOperationType` The possible write operations in the destination connector. When this value is not provided, this defaults to the `INSERT` operation. *Required*: No *Type*: String *Allowed values*: `INSERT | UPSERT | UPDATE | DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::AppFlow::Flow ZendeskSourceProperties The properties that are applied when using Zendesk as a flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-appflow-flow-zendesksourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-appflow-flow-zendesksourceproperties-object): String ``` ## Properties `Object` The object specified in the Zendesk flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [ZendeskSourceProperties](https://docs.aws.amazon.com/appflow/1.0/APIReference/API_ZendeskSourceProperties.html) in the *Amazon AppFlow API Reference*.