AWS::AppFlow::ConnectorProfile - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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.


If you want to use Amazon 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.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::AppFlow::ConnectorProfile", "Properties" : { "ConnectionMode" : String, "ConnectorLabel" : String, "ConnectorProfileConfig" : ConnectorProfileConfig, "ConnectorProfileName" : String, "ConnectorType" : String, "KMSArn" : String } }


Type: AWS::AppFlow::ConnectorProfile Properties: ConnectionMode: String ConnectorLabel: String ConnectorProfileConfig: ConnectorProfileConfig ConnectorProfileName: String ConnectorType: String KMSArn: String



Indicates the connection mode and if it is public or private.

Required: Yes

Type: String

Allowed values: Public | Private

Update requires: No interruption


The label for the connector profile being created.

Required: No

Type: String

Pattern: [\w!@#.-]+

Maximum: 256

Update requires: Replacement


Defines the connector-specific configuration and credentials.

Required: No

Type: ConnectorProfileConfig

Update requires: No interruption


The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

Required: Yes

Type: String

Pattern: [\w/!@#+=.-]+

Maximum: 256

Update requires: Replacement


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


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

Return values


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 Ref.


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 Fn::GetAtt.


The Amazon Resource Name (ARN) of the connector profile.


The Amazon Resource Name (ARN) of the connector profile credentials.

See also