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

# AWS::AppFlow::ConnectorProfile
<a name="aws-resource-appflow-connectorprofile"></a>

 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
<a name="aws-resource-appflow-connectorprofile-syntax"></a>

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

### JSON
<a name="aws-resource-appflow-connectorprofile-syntax.json"></a>

```
{
  "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
<a name="aws-resource-appflow-connectorprofile-syntax.yaml"></a>

```
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
<a name="aws-resource-appflow-connectorprofile-properties"></a>

`ConnectionMode`  <a name="cfn-appflow-connectorprofile-connectionmode"></a>
 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`  <a name="cfn-appflow-connectorprofile-connectorlabel"></a>
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`  <a name="cfn-appflow-connectorprofile-connectorprofileconfig"></a>
 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`  <a name="cfn-appflow-connectorprofile-connectorprofilename"></a>
 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`  <a name="cfn-appflow-connectorprofile-connectortype"></a>
 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`  <a name="cfn-appflow-connectorprofile-kmsarn"></a>
 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
<a name="aws-resource-appflow-connectorprofile-return-values"></a>

### Ref
<a name="aws-resource-appflow-connectorprofile-return-values-ref"></a>

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
<a name="aws-resource-appflow-connectorprofile-return-values-fn--getatt"></a>

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

#### 
<a name="aws-resource-appflow-connectorprofile-return-values-fn--getatt-fn--getatt"></a>

`ConnectorProfileArn`  <a name="ConnectorProfileArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the connector profile.

`CredentialsArn`  <a name="CredentialsArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the connector profile credentials.

## See also
<a name="aws-resource-appflow-connectorprofile--seealso"></a>
+ [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*.