AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppFlow::ConnectorProfile

CfnConnectorProfile

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

Import

import { CfnConnectorProfile } from 'aws-cdk-lib/aws-appflow';

Or use the module namespace:

import * as appflow from 'aws-cdk-lib/aws-appflow';
// appflow.CfnConnectorProfile

Properties

Configuration passed to the constructor as CfnConnectorProfileProps.

connectionModeRequired
string

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

connectorProfileNameRequired
string

The name of the connector profile. The name is unique for each `ConnectorProfile` in the AWS account .

connectorTypeRequired
string

The type of connector, such as Salesforce, Amplitude, and so on.

connectorLabelOptional
string

The label for the connector profile being created.

connectorProfileConfigOptional
IResolvable | ConnectorProfileConfigProperty

Defines the connector-specific configuration and credentials.

kmsArnOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AppFlow::ConnectorProfileView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-appflow
CFN TypeAWS::AppFlow::ConnectorProfile
Properties6

Related Constructs

Explore This Service

External Links