software.amazon.awscdk.services.appflow

Class CfnConnectorProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appflow.CfnConnectorProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.310Z")
 @Stability(value=Stable)
public class CfnConnectorProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppFlow::ConnectorProfile`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appflow.*;
 Object credentialsMap;
 Object oAuthCredentials;
 Object profileProperties;
 Object tokenUrlCustomProperties;
 CfnConnectorProfile cfnConnectorProfile = CfnConnectorProfile.Builder.create(this, "MyCfnConnectorProfile")
         .connectionMode("connectionMode")
         .connectorProfileName("connectorProfileName")
         .connectorType("connectorType")
         // the properties below are optional
         .connectorLabel("connectorLabel")
         .connectorProfileConfig(ConnectorProfileConfigProperty.builder()
                 .connectorProfileCredentials(ConnectorProfileCredentialsProperty.builder()
                         .amplitude(AmplitudeConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .secretKey("secretKey")
                                 .build())
                         .customConnector(CustomConnectorProfileCredentialsProperty.builder()
                                 .authenticationType("authenticationType")
                                 // the properties below are optional
                                 .apiKey(ApiKeyCredentialsProperty.builder()
                                         .apiKey("apiKey")
                                         // the properties below are optional
                                         .apiSecretKey("apiSecretKey")
                                         .build())
                                 .basic(BasicAuthCredentialsProperty.builder()
                                         .password("password")
                                         .username("username")
                                         .build())
                                 .custom(CustomAuthCredentialsProperty.builder()
                                         .customAuthenticationType("customAuthenticationType")
                                         // the properties below are optional
                                         .credentialsMap(credentialsMap)
                                         .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()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .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()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .redshift(RedshiftConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .salesforce(SalesforceConnectorProfileCredentialsProperty.builder()
                                 .accessToken("accessToken")
                                 .clientCredentialsArn("clientCredentialsArn")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .refreshToken("refreshToken")
                                 .build())
                         .sapoData(SAPODataConnectorProfileCredentialsProperty.builder()
                                 .basicAuthCredentials(BasicAuthCredentialsProperty.builder()
                                         .password("password")
                                         .username("username")
                                         .build())
                                 .oAuthCredentials(oAuthCredentials)
                                 .build())
                         .serviceNow(ServiceNowConnectorProfileCredentialsProperty.builder()
                                 .password("password")
                                 .username("username")
                                 .build())
                         .singular(SingularConnectorProfileCredentialsProperty.builder()
                                 .apiKey("apiKey")
                                 .build())
                         .slack(SlackConnectorProfileCredentialsProperty.builder()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .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()
                                 .clientId("clientId")
                                 .clientSecret("clientSecret")
                                 // the properties below are optional
                                 .accessToken("accessToken")
                                 .connectorOAuthRequest(ConnectorOAuthRequestProperty.builder()
                                         .authCode("authCode")
                                         .redirectUri("redirectUri")
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .connectorProfileProperties(ConnectorProfilePropertiesProperty.builder()
                         .customConnector(CustomConnectorProfilePropertiesProperty.builder()
                                 .oAuth2Properties(OAuth2PropertiesProperty.builder()
                                         .oAuth2GrantType("oAuth2GrantType")
                                         .tokenUrl("tokenUrl")
                                         .tokenUrlCustomProperties(tokenUrlCustomProperties)
                                         .build())
                                 .profileProperties(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())
                         .redshift(RedshiftConnectorProfilePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .databaseUrl("databaseUrl")
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .bucketPrefix("bucketPrefix")
                                 .build())
                         .salesforce(SalesforceConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .isSandboxEnvironment(false)
                                 .build())
                         .sapoData(SAPODataConnectorProfilePropertiesProperty.builder()
                                 .applicationHostUrl("applicationHostUrl")
                                 .applicationServicePath("applicationServicePath")
                                 .clientNumber("clientNumber")
                                 .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()
                                 .bucketName("bucketName")
                                 .stage("stage")
                                 .warehouse("warehouse")
                                 // the properties below are optional
                                 .accountName("accountName")
                                 .bucketPrefix("bucketPrefix")
                                 .privateLinkServiceName("privateLinkServiceName")
                                 .region("region")
                                 .build())
                         .veeva(VeevaConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .zendesk(ZendeskConnectorProfilePropertiesProperty.builder()
                                 .instanceUrl("instanceUrl")
                                 .build())
                         .build())
                 .build())
         .kmsArn("kmsArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty The connector-specific credentials required when using Amplitude.
static interface	CfnConnectorProfile.ApiKeyCredentialsProperty Example:
static interface	CfnConnectorProfile.BasicAuthCredentialsProperty Example:
static class	CfnConnectorProfile.Builder A fluent builder for CfnConnectorProfile.
static interface	CfnConnectorProfile.ConnectorOAuthRequestProperty Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
static interface	CfnConnectorProfile.ConnectorProfileConfigProperty Defines the connector-specific configuration and credentials for the connector profile.
static interface	CfnConnectorProfile.ConnectorProfileCredentialsProperty The connector-specific credentials required by a connector.
static interface	CfnConnectorProfile.ConnectorProfilePropertiesProperty The connector-specific profile properties required by each connector.
static interface	CfnConnectorProfile.CustomAuthCredentialsProperty Example:
static interface	CfnConnectorProfile.CustomConnectorProfileCredentialsProperty Example:
static interface	CfnConnectorProfile.CustomConnectorProfilePropertiesProperty Example:
static interface	CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty The connector-specific credentials required by Datadog.
static interface	CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty The connector-specific profile properties required by Datadog.
static interface	CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty The connector-specific profile credentials required by Dynatrace.
static interface	CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty The connector-specific profile properties required by Dynatrace.
static interface	CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty The connector-specific profile credentials required by Google Analytics.
static interface	CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty The connector-specific profile credentials required by Infor Nexus.
static interface	CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty The connector-specific profile properties required by Infor Nexus.
static interface	CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty The connector-specific profile credentials required by Marketo.
static interface	CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty The connector-specific profile properties required when using Marketo.
static interface	CfnConnectorProfile.OAuth2CredentialsProperty Example:
static interface	CfnConnectorProfile.OAuth2PropertiesProperty Example:
static interface	CfnConnectorProfile.OAuthPropertiesProperty The OAuth properties required for OAuth type authentication.
static interface	CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Amazon Redshift.
static interface	CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty The connector-specific profile properties when using Amazon Redshift.
static interface	CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Salesforce.
static interface	CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty The connector-specific profile properties required when using Salesforce.
static interface	CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty The connector-specific profile credentials required when using SAPOData.
static interface	CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty The connector-specific profile properties required when using SAPOData.
static interface	CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty The connector-specific profile credentials required when using ServiceNow.
static interface	CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty The connector-specific profile properties required when using ServiceNow.
static interface	CfnConnectorProfile.SingularConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Singular.
static interface	CfnConnectorProfile.SlackConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Slack.
static interface	CfnConnectorProfile.SlackConnectorProfilePropertiesProperty The connector-specific profile properties required when using Slack.
static interface	CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Snowflake.
static interface	CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty The connector-specific profile properties required when using Snowflake.
static interface	CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Trend Micro.
static interface	CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Veeva.
static interface	CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty The connector-specific profile properties required when using Veeva.
static interface	CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty The connector-specific profile credentials required when using Zendesk.
static interface	CfnConnectorProfile.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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectorProfile(software.constructs.Construct scope, String id, CfnConnectorProfileProps props) Create a new `AWS::AppFlow::ConnectorProfile`.
protected	CfnConnectorProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrConnectorProfileArn() The Amazon Resource Name (ARN) of the connector profile.
String	getAttrCredentialsArn() The Amazon Resource Name (ARN) of the connector profile credentials.
protected Map<String,Object>	getCfnProperties()
String	getConnectionMode() Indicates the connection mode and if it is public or private.
String	getConnectorLabel() `AWS::AppFlow::ConnectorProfile.ConnectorLabel`.
Object	getConnectorProfileConfig() Defines the connector-specific configuration and credentials.
String	getConnectorProfileName() The name of the connector profile.
String	getConnectorType() The type of connector, such as Salesforce, Amplitude, and so on.
String	getKmsArn() The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectionMode(String value) Indicates the connection mode and if it is public or private.
void	setConnectorLabel(String value) `AWS::AppFlow::ConnectorProfile.ConnectorLabel`.
void	setConnectorProfileConfig(CfnConnectorProfile.ConnectorProfileConfigProperty value) Defines the connector-specific configuration and credentials.
void	setConnectorProfileConfig(IResolvable value) Defines the connector-specific configuration and credentials.
void	setConnectorProfileName(String value) The name of the connector profile.
void	setConnectorType(String value) The type of connector, such as Salesforce, Amplitude, and so on.
void	setKmsArn(String value) The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnectorProfile

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

CfnConnectorProfile

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

CfnConnectorProfile

@Stability(value=Stable)
public CfnConnectorProfile(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnConnectorProfileProps props)

Create a new `AWS::AppFlow::ConnectorProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrConnectorProfileArn

@Stability(value=Stable)
 @NotNull
public String getAttrConnectorProfileArn()

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

getAttrCredentialsArn

@Stability(value=Stable)
 @NotNull
public String getAttrCredentialsArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectionMode

@Stability(value=Stable)
 @NotNull
public String getConnectionMode()

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

setConnectionMode

@Stability(value=Stable)
public void setConnectionMode(@NotNull
                                                       String value)

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

getConnectorProfileName

@Stability(value=Stable)
 @NotNull
public String getConnectorProfileName()

The name of the connector profile.

The name is unique for each ConnectorProfile in the AWS account .

setConnectorProfileName

@Stability(value=Stable)
public void setConnectorProfileName(@NotNull
                                                             String value)

The name of the connector profile.

The name is unique for each ConnectorProfile in the AWS account .

getConnectorType

@Stability(value=Stable)
 @NotNull
public String getConnectorType()

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

setConnectorType

@Stability(value=Stable)
public void setConnectorType(@NotNull
                                                      String value)

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

getConnectorLabel

@Stability(value=Stable)
 @Nullable
public String getConnectorLabel()

`AWS::AppFlow::ConnectorProfile.ConnectorLabel`.

setConnectorLabel

@Stability(value=Stable)
public void setConnectorLabel(@Nullable
                                                       String value)

`AWS::AppFlow::ConnectorProfile.ConnectorLabel`.

getConnectorProfileConfig

@Stability(value=Stable)
 @Nullable
public Object getConnectorProfileConfig()

Defines the connector-specific configuration and credentials.

setConnectorProfileConfig

@Stability(value=Stable)
public void setConnectorProfileConfig(@Nullable
                                                               CfnConnectorProfile.ConnectorProfileConfigProperty value)

Defines the connector-specific configuration and credentials.

setConnectorProfileConfig

@Stability(value=Stable)
public void setConnectorProfileConfig(@Nullable
                                                               IResolvable value)

Defines the connector-specific configuration and credentials.

getKmsArn

@Stability(value=Stable)
 @Nullable
public String getKmsArn()

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

setKmsArn

@Stability(value=Stable)
public void setKmsArn(@Nullable
                                               String value)

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.

This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.