Class CfnConnectorProfile

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnConnectorProfile

Implements

IInspectable

IConnectorProfileRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppFlow

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConnectorProfile : CfnResource, IInspectable, IConnectorProfileRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnConnectorProfile Inherits CfnResource Implements IInspectable, IConnectorProfileRef, IConstruct, IDependable, IEnvironmentAware

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

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(Construct, string, ICfnConnectorProfileProps)

Create a new AWS::AppFlow::ConnectorProfile.

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	The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.
CfnPropertyNames	The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.
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.
ConnectorProfileRef	A reference to a ConnectorProfile resource.
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

ArnForConnectorProfile(IConnectorProfileRef)	The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnConnectorProfile(object)	Checks whether the given object is a CfnConnectorProfile.
RenderProperties(IDictionary<string, object>)	The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

Constructors

CfnConnectorProfile(Construct, string, ICfnConnectorProfileProps)

Create a new AWS::AppFlow::ConnectorProfile.

public CfnConnectorProfile(Construct scope, string id, ICfnConnectorProfileProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnConnectorProfileProps

Resource properties.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

Properties

AttrConnectorProfileArn

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

public virtual string AttrConnectorProfileArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ConnectorProfileArn

AttrCredentialsArn

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

public virtual string AttrCredentialsArn { get; }

Property Value

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

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

ConnectionMode

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

public virtual string ConnectionMode { get; set; }

Property Value

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

ConnectorLabel

The label for the connector profile being created.

public virtual string? ConnectorLabel { get; set; }

Property Value

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

ConnectorProfileConfig

Defines the connector-specific configuration and credentials.

public virtual object? ConnectorProfileConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnConnectorProfile.IConnectorProfileConfigProperty

ConnectorProfileName

The name of the connector profile.

public virtual string ConnectorProfileName { get; set; }

Property Value

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

ConnectorProfileRef

A reference to a ConnectorProfile resource.

public virtual IConnectorProfileReference ConnectorProfileRef { get; }

Property Value

IConnectorProfileReference

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

ConnectorType

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

public virtual string ConnectorType { get; set; }

Property Value

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

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

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

Methods

ArnForConnectorProfile(IConnectorProfileRef)

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

public static string ArnForConnectorProfile(IConnectorProfileRef resource)

Parameters

resource IConnectorProfileRef

Returns

string

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

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"
             });

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.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

IsCfnConnectorProfile(object)

Checks whether the given object is a CfnConnectorProfile.

public static bool IsCfnConnectorProfile(object x)

Parameters

x object

Returns

bool

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appflow-connectorprofile.html

CloudformationResource: AWS::AppFlow::ConnectorProfile

ExampleMetadata: fixture=_generated

Implements

IInspectable

IConnectorProfileRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware