Class CfnConnectorProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:12.224Z") @Stability(Stable) public class CfnConnectorProfile extends CfnResource implements IInspectable
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.*;
 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(Map.of(
                                                 "credentialsMapKey", "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())
                         .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()
                                 .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())
                 .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")
                                 // the properties below are optional
                                 .instanceUrl("instanceUrl")
                                 .isSandboxEnvironment(false)
                                 .build())
                         .redshift(RedshiftConnectorProfilePropertiesProperty.builder()
                                 .bucketName("bucketName")
                                 .roleArn("roleArn")
                                 // the properties below are optional
                                 .bucketPrefix("bucketPrefix")
                                 .clusterIdentifier("clusterIdentifier")
                                 .dataApiRoleArn("dataApiRoleArn")
                                 .databaseName("databaseName")
                                 .databaseUrl("databaseUrl")
                                 .isRedshiftServerless(false)
                                 .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()
                                 .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();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnConnectorProfile

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

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

      @Stability(Stable) public CfnConnectorProfile(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectorProfileProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrConnectorProfileArn()
      The Amazon Resource Name (ARN) of the connector profile.
    • getAttrCredentialsArn

      @Stability(Stable) @NotNull public String getAttrCredentialsArn()
      The Amazon Resource Name (ARN) of the connector profile credentials.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getConnectionMode

      @Stability(Stable) @NotNull public String getConnectionMode()
      Indicates the connection mode and if it is public or private.
    • setConnectionMode

      @Stability(Stable) public void setConnectionMode(@NotNull String value)
      Indicates the connection mode and if it is public or private.
    • getConnectorProfileName

      @Stability(Stable) @NotNull public String getConnectorProfileName()
      The name of the connector profile.
    • setConnectorProfileName

      @Stability(Stable) public void setConnectorProfileName(@NotNull String value)
      The name of the connector profile.
    • getConnectorType

      @Stability(Stable) @NotNull public String getConnectorType()
      The type of connector, such as Salesforce, Amplitude, and so on.
    • setConnectorType

      @Stability(Stable) public void setConnectorType(@NotNull String value)
      The type of connector, such as Salesforce, Amplitude, and so on.
    • getConnectorLabel

      @Stability(Stable) @Nullable public String getConnectorLabel()
      The label for the connector profile being created.
    • setConnectorLabel

      @Stability(Stable) public void setConnectorLabel(@Nullable String value)
      The label for the connector profile being created.
    • getConnectorProfileConfig

      @Stability(Stable) @Nullable public Object getConnectorProfileConfig()
      Defines the connector-specific configuration and credentials.
    • setConnectorProfileConfig

      @Stability(Stable) public void setConnectorProfileConfig(@Nullable IResolvable value)
      Defines the connector-specific configuration and credentials.
    • setConnectorProfileConfig

      @Stability(Stable) public void setConnectorProfileConfig(@Nullable CfnConnectorProfile.ConnectorProfileConfigProperty value)
      Defines the connector-specific configuration and credentials.
    • getKmsArn

      @Stability(Stable) @Nullable public String getKmsArn()
      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
    • setKmsArn

      @Stability(Stable) public void setKmsArn(@Nullable String value)
      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.