Package software.amazon.awscdk.cfnpropertymixins.services.appflow

Class CfnConnectorProfilePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appflow.CfnConnectorProfilePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.594Z")
@Stability(Stable)
public class CfnConnectorProfilePropsMixin
extends Mixin
implements software.constructs.IMixin

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appflow.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnConnectorProfilePropsMixin cfnConnectorProfilePropsMixin = CfnConnectorProfilePropsMixin.Builder.create(CfnConnectorProfileMixinProps.builder()
         .connectionMode("connectionMode")
         .connectorLabel("connectorLabel")
         .connectorProfileConfig(ConnectorProfileConfigProperty.builder()
                 .connectorProfileCredentials(ConnectorProfileCredentialsProperty.builder()
                         .amplitude(AmplitudeConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .secretKey("secretKey")
                                 .build())
                         .customConnector(CustomConnectorProfileCredentialsProperty.builder()
                                 .apiKey(ApiKeyCredentialsProperty.builder()
                                         .apiKey("apiKey")
                                         .apiSecretKey("apiSecretKey")
                                         .build())
                                 .authenticationType("authenticationType")
                                 .basic(BasicAuthCredentialsProperty.builder()
                                         .password("password")
                                         .username("username")
                                         .build())
                                 .custom(CustomAuthCredentialsProperty.builder()
                                         .credentialsMap(Map.of(
                                                 "credentialsMapKey", "credentialsMap"))
                                         .customAuthenticationType("customAuthenticationType")
                                         .build())
                                 .oauth2(OAuth2CredentialsProperty.builder()
                                         .accessToken("accessToken")
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         .oAuthRequest(ConnectorOAuthRequestProperty.builder()
                                                 .authCode("authCode")
                                                 .redirectUri("redirectUri")
                                                 .build())
                                         .refreshToken("refreshToken")
                                         .build())
                                 .build())
                         .datadog(DatadogConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .applicationKey("applicationKey")
                                 .build())
                         .dynatrace(DynatraceConnectorProfileCredentialsProperty.builder()
                                 .apiToken("apiToken")
                                 .build())
                         .googleAnalytics(GoogleAnalyticsConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .refreshToken("refreshToken")
                                 .build())
                         .inforNexus(InforNexusConnectorProfileCredentialsProperty.builder()
                                 .accessKeyId("accessKeyId")
                                 .datakey("datakey")
                                 .secretAccessKey("secretAccessKey")
                                 .userId("userId")
                                 .build())
                         .marketo(MarketoConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .pardot(PardotConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientCredentialsArn("clientCredentialsArn")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .refreshToken("refreshToken")
                                 .build())
                         .redshift(RedshiftConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .salesforce(SalesforceConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientCredentialsArn("clientCredentialsArn")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .jwtToken("jwtToken")
                                 .oAuth2GrantType("oAuth2GrantType")
                                 .refreshToken("refreshToken")
                                 .build())
                         .sapoData(SAPODataConnectorProfileCredentialsProperty.builder()
                                 .basicAuthCredentials(BasicAuthCredentialsProperty.builder()
                                         .password("password")
                                         .username("username")
                                         .build())
                                 .oAuthCredentials(OAuthCredentialsProperty.builder()
                                         .accessToken("accessToken")
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                                 .authCode("authCode")
                                                 .redirectUri("redirectUri")
                                                 .build())
                                         .refreshToken("refreshToken")
                                         .build())
                                 .build())
                         .serviceNow(ServiceNowConnectorProfileCredentialsProperty.builder()
                                 .oAuth2Credentials(OAuth2CredentialsProperty.builder()
                                         .accessToken("accessToken")
                                         .clientId("clientId")
                                         .clientSecret("clientSecret")
                                         .oAuthRequest(ConnectorOAuthRequestProperty.builder()
                                                 .authCode("authCode")
                                                 .redirectUri("redirectUri")
                                                 .build())
                                         .refreshToken("refreshToken")
                                         .build())
                                 .password("password")
                                 .username("username")
                                 .build())
                         .singular(SingularConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .build())
                         .slack(SlackConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .snowflake(SnowflakeConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .trendmicro(TrendmicroConnectorProfileCredentialsProperty.builder()
                                 .apiSecretKey("apiSecretKey")
                                 .build())
                         .veeva(VeevaConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .zendesk(ZendeskConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .build())
                 .connectorProfileProperties(ConnectorProfilePropertiesProperty.builder()
                         .customConnector(CustomConnectorProfilePropertiesProperty.builder()
                                 .oAuth2Properties(OAuth2PropertiesProperty.builder()
                                         .oAuth2GrantType("oAuth2GrantType")
                                         .tokenUrl("tokenUrl")
                                         .tokenUrlCustomProperties(Map.of(
                                                 "tokenUrlCustomPropertiesKey", "tokenUrlCustomProperties"))
                                         .build())
                                 .profileProperties(Map.of(
                                         "profilePropertiesKey", "profileProperties"))
                                 .build())
                         .datadog(DatadogConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .dynatrace(DynatraceConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .inforNexus(InforNexusConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .marketo(MarketoConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .pardot(PardotConnectorProfilePropertiesProperty.builder()
                                 .businessUnitId("businessUnitId")
                                 .instanceUrl("instanceUrl")
                                 .isSandboxEnvironment(false)
                                 .build())
                         .redshift(RedshiftConnectorProfilePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .clusterIdentifier("clusterIdentifier")
                                 .dataApiRoleArn("dataApiRoleArn")
                                 .databaseName("databaseName")
                                 .databaseUrl("databaseUrl")
                                 .isRedshiftServerless(false)
                                 .roleArn("roleArn")
                                 .workgroupName("workgroupName")
                                 .build())
                         .salesforce(SalesforceConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .isSandboxEnvironment(false)
                                 .usePrivateLinkForMetadataAndAuthorization(false)
                                 .build())
                         .sapoData(SAPODataConnectorProfilePropertiesProperty.builder()
                                 .applicationHostUrl("applicationHostUrl")
                                 .applicationServicePath("applicationServicePath")
                                 .clientNumber("clientNumber")
                                 .disableSso(false)
                                 .logonLanguage("logonLanguage")
                                 .oAuthProperties(OAuthPropertiesProperty.builder()
                                         .authCodeUrl("authCodeUrl")
                                         .oAuthScopes(List.of("oAuthScopes"))
                                         .tokenUrl("tokenUrl")
                                         .build())
                                 .portNumber(123)
                                 .privateLinkServiceName("privateLinkServiceName")
                                 .build())
                         .serviceNow(ServiceNowConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .slack(SlackConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .snowflake(SnowflakeConnectorProfilePropertiesProperty.builder()
                                 .accountName("accountName")
                                 .bucketName("bucketName")
                                 .bucketPrefix("bucketPrefix")
                                 .privateLinkServiceName("privateLinkServiceName")
                                 .region("region")
                                 .stage("stage")
                                 .warehouse("warehouse")
                                 .build())
                         .veeva(VeevaConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .zendesk(ZendeskConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .build())
                 .build())
         .connectorProfileName("connectorProfileName")
         .connectorType("connectorType")
         .kmsArn("kmsArn")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty	The connector-specific credentials required when using Amplitude.
static interface	CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty	The API key credentials required for API key authentication.
static interface	CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty	The basic auth credentials required for basic authentication.
static final class	CfnConnectorProfilePropsMixin.Builder	A fluent builder for CfnConnectorProfilePropsMixin.
static interface	CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty	Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
static interface	CfnConnectorProfilePropsMixin.ConnectorProfileConfigProperty	Defines the connector-specific configuration and credentials for the connector profile.
static interface	CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty	The connector-specific credentials required by a connector.
static interface	CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty	The connector-specific profile properties required by each connector.
static interface	CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty	The custom credentials required for custom authentication.
static interface	CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty	The connector-specific profile credentials that are required when using the custom connector.
static interface	CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty	The profile properties required by the custom connector.
static interface	CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty	The connector-specific credentials required by Datadog.
static interface	CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty	The connector-specific profile properties required by Datadog.
static interface	CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty	The connector-specific profile credentials required by Dynatrace.
static interface	CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty	The connector-specific profile properties required by Dynatrace.
static interface	CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty	The connector-specific profile credentials required by Google Analytics.
static interface	CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty	The connector-specific profile credentials required by Infor Nexus.
static interface	CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty	The connector-specific profile properties required by Infor Nexus.
static interface	CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty	The connector-specific profile credentials required by Marketo.
static interface	CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Marketo.
static interface	CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty	The OAuth 2.0 credentials required for OAuth 2.0 authentication.
static interface	CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty	The OAuth 2.0 properties required for OAuth 2.0 authentication.
static interface	CfnConnectorProfilePropsMixin.OAuthCredentialsProperty	The OAuth credentials required for OAuth type authentication.
static interface	CfnConnectorProfilePropsMixin.OAuthPropertiesProperty	The OAuth properties required for OAuth type authentication.
static interface	CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Salesforce Pardot.
static interface	CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Salesforce Pardot.
static interface	CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Amazon Redshift.
static interface	CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty	The connector-specific profile properties when using Amazon Redshift.
static interface	CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Salesforce.
static interface	CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Salesforce.
static interface	CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using SAPOData.
static interface	CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty	The connector-specific profile properties required when using SAPOData.
static interface	CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using ServiceNow.
static interface	CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty	The connector-specific profile properties required when using ServiceNow.
static interface	CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Singular.
static interface	CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Slack.
static interface	CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Slack.
static interface	CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Snowflake.
static interface	CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Snowflake.
static interface	CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Trend Micro.
static interface	CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Veeva.
static interface	CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Veeva.
static interface	CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty	The connector-specific profile credentials required when using Zendesk.
static interface	CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty	The connector-specific profile properties required when using Zendesk.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnConnectorProfilePropsMixin(CfnConnectorProfileMixinProps props)	Create a mixin to apply properties to AWS::AppFlow::ConnectorProfile.
	CfnConnectorProfilePropsMixin(CfnConnectorProfileMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppFlow::ConnectorProfile.
protected	CfnConnectorProfilePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorProfilePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnConnectorProfileMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnConnectorProfilePropsMixin

protected CfnConnectorProfilePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnConnectorProfilePropsMixin

protected CfnConnectorProfilePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConnectorProfilePropsMixin

@Stability(Stable)
public CfnConnectorProfilePropsMixin(@NotNull
 CfnConnectorProfileMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppFlow::ConnectorProfile.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnConnectorProfilePropsMixin

@Stability(Stable)
public CfnConnectorProfilePropsMixin(@NotNull
 CfnConnectorProfileMixinProps props)

Create a mixin to apply properties to AWS::AppFlow::ConnectorProfile.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnConnectorProfileMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()