Class CfnConnectorProfile
The AWS::AppFlow::ConnectorProfile
resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppFlow
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConnectorProfile : CfnResource, IInspectable
Syntax (vb)
Public Class CfnConnectorProfile
Inherits CfnResource
Implements IInspectable
Remarks
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 AWS 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.
CloudformationResource: AWS::AppFlow::ConnectorProfile
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppFlow;
var cfnConnectorProfile = new CfnConnectorProfile(this, "MyCfnConnectorProfile", new CfnConnectorProfileProps {
ConnectionMode = "connectionMode",
ConnectorProfileName = "connectorProfileName",
ConnectorType = "connectorType",
// the properties below are optional
ConnectorLabel = "connectorLabel",
ConnectorProfileConfig = new ConnectorProfileConfigProperty {
ConnectorProfileCredentials = new ConnectorProfileCredentialsProperty {
Amplitude = new AmplitudeConnectorProfileCredentialsProperty {
ApiKey = "apiKey",
SecretKey = "secretKey"
},
CustomConnector = new CustomConnectorProfileCredentialsProperty {
AuthenticationType = "authenticationType",
// the properties below are optional
ApiKey = new ApiKeyCredentialsProperty {
ApiKey = "apiKey",
// the properties below are optional
ApiSecretKey = "apiSecretKey"
},
Basic = new BasicAuthCredentialsProperty {
Password = "password",
Username = "username"
},
Custom = new CustomAuthCredentialsProperty {
CustomAuthenticationType = "customAuthenticationType",
// the properties below are optional
CredentialsMap = new Dictionary<string, string> {
{ "credentialsMapKey", "credentialsMap" }
}
},
Oauth2 = new OAuth2CredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
OAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
}
},
Datadog = new DatadogConnectorProfileCredentialsProperty {
ApiKey = "apiKey",
ApplicationKey = "applicationKey"
},
Dynatrace = new DynatraceConnectorProfileCredentialsProperty {
ApiToken = "apiToken"
},
GoogleAnalytics = new GoogleAnalyticsConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
InforNexus = new InforNexusConnectorProfileCredentialsProperty {
AccessKeyId = "accessKeyId",
Datakey = "datakey",
SecretAccessKey = "secretAccessKey",
UserId = "userId"
},
Marketo = new MarketoConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
},
Pardot = new PardotConnectorProfileCredentialsProperty {
AccessToken = "accessToken",
ClientCredentialsArn = "clientCredentialsArn",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
Redshift = new RedshiftConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Salesforce = new SalesforceConnectorProfileCredentialsProperty {
AccessToken = "accessToken",
ClientCredentialsArn = "clientCredentialsArn",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
JwtToken = "jwtToken",
OAuth2GrantType = "oAuth2GrantType",
RefreshToken = "refreshToken"
},
SapoData = new SAPODataConnectorProfileCredentialsProperty {
BasicAuthCredentials = new BasicAuthCredentialsProperty {
Password = "password",
Username = "username"
},
OAuthCredentials = new OAuthCredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
}
},
ServiceNow = new ServiceNowConnectorProfileCredentialsProperty {
OAuth2Credentials = new OAuth2CredentialsProperty {
AccessToken = "accessToken",
ClientId = "clientId",
ClientSecret = "clientSecret",
OAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
},
RefreshToken = "refreshToken"
},
Password = "password",
Username = "username"
},
Singular = new SingularConnectorProfileCredentialsProperty {
ApiKey = "apiKey"
},
Slack = new SlackConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
},
Snowflake = new SnowflakeConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Trendmicro = new TrendmicroConnectorProfileCredentialsProperty {
ApiSecretKey = "apiSecretKey"
},
Veeva = new VeevaConnectorProfileCredentialsProperty {
Password = "password",
Username = "username"
},
Zendesk = new ZendeskConnectorProfileCredentialsProperty {
ClientId = "clientId",
ClientSecret = "clientSecret",
// the properties below are optional
AccessToken = "accessToken",
ConnectorOAuthRequest = new ConnectorOAuthRequestProperty {
AuthCode = "authCode",
RedirectUri = "redirectUri"
}
}
},
ConnectorProfileProperties = new ConnectorProfilePropertiesProperty {
CustomConnector = new CustomConnectorProfilePropertiesProperty {
OAuth2Properties = new OAuth2PropertiesProperty {
OAuth2GrantType = "oAuth2GrantType",
TokenUrl = "tokenUrl",
TokenUrlCustomProperties = new Dictionary<string, string> {
{ "tokenUrlCustomPropertiesKey", "tokenUrlCustomProperties" }
}
},
ProfileProperties = new Dictionary<string, string> {
{ "profilePropertiesKey", "profileProperties" }
}
},
Datadog = new DatadogConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Dynatrace = new DynatraceConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
InforNexus = new InforNexusConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Marketo = new MarketoConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Pardot = new PardotConnectorProfilePropertiesProperty {
BusinessUnitId = "businessUnitId",
// the properties below are optional
InstanceUrl = "instanceUrl",
IsSandboxEnvironment = false
},
Redshift = new RedshiftConnectorProfilePropertiesProperty {
BucketName = "bucketName",
RoleArn = "roleArn",
// the properties below are optional
BucketPrefix = "bucketPrefix",
ClusterIdentifier = "clusterIdentifier",
DataApiRoleArn = "dataApiRoleArn",
DatabaseName = "databaseName",
DatabaseUrl = "databaseUrl",
IsRedshiftServerless = false,
WorkgroupName = "workgroupName"
},
Salesforce = new SalesforceConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl",
IsSandboxEnvironment = false,
UsePrivateLinkForMetadataAndAuthorization = false
},
SapoData = new SAPODataConnectorProfilePropertiesProperty {
ApplicationHostUrl = "applicationHostUrl",
ApplicationServicePath = "applicationServicePath",
ClientNumber = "clientNumber",
DisableSso = false,
LogonLanguage = "logonLanguage",
OAuthProperties = new OAuthPropertiesProperty {
AuthCodeUrl = "authCodeUrl",
OAuthScopes = new [] { "oAuthScopes" },
TokenUrl = "tokenUrl"
},
PortNumber = 123,
PrivateLinkServiceName = "privateLinkServiceName"
},
ServiceNow = new ServiceNowConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Slack = new SlackConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Snowflake = new SnowflakeConnectorProfilePropertiesProperty {
BucketName = "bucketName",
Stage = "stage",
Warehouse = "warehouse",
// the properties below are optional
AccountName = "accountName",
BucketPrefix = "bucketPrefix",
PrivateLinkServiceName = "privateLinkServiceName",
Region = "region"
},
Veeva = new VeevaConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
},
Zendesk = new ZendeskConnectorProfilePropertiesProperty {
InstanceUrl = "instanceUrl"
}
}
},
KmsArn = "kmsArn"
});
Synopsis
Constructors
CfnConnectorProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConnectorProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConnectorProfile(Construct, String, ICfnConnectorProfileProps) |
Properties
AttrConnectorProfileArn | The Amazon Resource Name (ARN) of the connector profile. |
AttrCredentialsArn | The Amazon Resource Name (ARN) of the connector profile credentials. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConnectionMode | Indicates the connection mode and if it is public or private. |
ConnectorLabel | The label for the connector profile being created. |
ConnectorProfileConfig | Defines the connector-specific configuration and credentials. |
ConnectorProfileName | The name of the connector profile. |
ConnectorType | The type of connector, such as Salesforce, Amplitude, and so on. |
KmsArn | The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConnectorProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConnectorProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConnectorProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConnectorProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConnectorProfile(Construct, String, ICfnConnectorProfileProps)
public CfnConnectorProfile(Construct scope, string id, ICfnConnectorProfileProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConnectorProfileProps
Resource properties.
Properties
AttrConnectorProfileArn
The Amazon Resource Name (ARN) of the connector profile.
public virtual string AttrConnectorProfileArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ConnectorProfileArn
AttrCredentialsArn
The Amazon Resource Name (ARN) of the connector profile credentials.
public virtual string AttrCredentialsArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CredentialsArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConnectionMode
Indicates the connection mode and if it is public or private.
public virtual string ConnectionMode { get; set; }
Property Value
System.String
ConnectorLabel
The label for the connector profile being created.
public virtual string ConnectorLabel { get; set; }
Property Value
System.String
ConnectorProfileConfig
Defines the connector-specific configuration and credentials.
public virtual object ConnectorProfileConfig { get; set; }
Property Value
System.Object
ConnectorProfileName
The name of the connector profile.
public virtual string ConnectorProfileName { get; set; }
Property Value
System.String
ConnectorType
The type of connector, such as Salesforce, Amplitude, and so on.
public virtual string ConnectorType { get; set; }
Property Value
System.String
KmsArn
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
public virtual string KmsArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>