CfnConnectorProfileProps

class aws_cdk.aws_appflow.CfnConnectorProfileProps(*, connection_mode, connector_profile_name, connector_type, connector_profile_config=None, kms_arn=None)

Bases: object

Properties for defining a CfnConnectorProfile.

Parameters
  • connection_mode (str) – Indicates the connection mode and if it is public or private.

  • connector_profile_name (str) – The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account .

  • connector_type (str) – The type of connector, such as Salesforce, Amplitude, and so on.

  • connector_profile_config (Union[ConnectorProfileConfigProperty, IResolvable, None]) – Defines the connector-specific configuration and credentials.

  • kms_arn (Optional[str]) – 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appflow as appflow

# basic_auth_credentials: Any
# o_auth_credentials: Any

cfn_connector_profile_props = appflow.CfnConnectorProfileProps(
    connection_mode="connectionMode",
    connector_profile_name="connectorProfileName",
    connector_type="connectorType",

    # the properties below are optional
    connector_profile_config=appflow.CfnConnectorProfile.ConnectorProfileConfigProperty(
        connector_profile_credentials=appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty(
            amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty(
                api_key="apiKey",
                secret_key="secretKey"
            ),
            datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty(
                api_key="apiKey",
                application_key="applicationKey"
            ),
            dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty(
                api_token="apiToken"
            ),
            google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                access_token="accessToken",
                connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            ),
            infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty(
                access_key_id="accessKeyId",
                datakey="datakey",
                secret_access_key="secretAccessKey",
                user_id="userId"
            ),
            marketo=appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                access_token="accessToken",
                connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            ),
            redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_credentials_arn="clientCredentialsArn",
                connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            ),
            sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty(
                basic_auth_credentials=basic_auth_credentials,
                o_auth_credentials=o_auth_credentials
            ),
            service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            singular=appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty(
                api_key="apiKey"
            ),
            slack=appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                access_token="accessToken",
                connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            ),
            snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            trendmicro=appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty(
                api_secret_key="apiSecretKey"
            ),
            veeva=appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty(
                client_id="clientId",
                client_secret="clientSecret",

                # the properties below are optional
                access_token="accessToken",
                connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            )
        ),

        # the properties below are optional
        connector_profile_properties=appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty(
            datadog=appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            marketo=appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty(
                bucket_name="bucketName",
                database_url="databaseUrl",
                role_arn="roleArn",

                # the properties below are optional
                bucket_prefix="bucketPrefix"
            ),
            salesforce=appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty(
                instance_url="instanceUrl",
                is_sandbox_environment=False
            ),
            sapo_data=appflow.CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty(
                application_host_url="applicationHostUrl",
                application_service_path="applicationServicePath",
                client_number="clientNumber",
                logon_language="logonLanguage",
                o_auth_properties=appflow.CfnConnectorProfile.OAuthPropertiesProperty(
                    auth_code_url="authCodeUrl",
                    o_auth_scopes=["oAuthScopes"],
                    token_url="tokenUrl"
                ),
                port_number=123,
                private_link_service_name="privateLinkServiceName"
            ),
            service_now=appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            slack=appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            snowflake=appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty(
                bucket_name="bucketName",
                stage="stage",
                warehouse="warehouse",

                # the properties below are optional
                account_name="accountName",
                bucket_prefix="bucketPrefix",
                private_link_service_name="privateLinkServiceName",
                region="region"
            ),
            veeva=appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            zendesk=appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            )
        )
    ),
    kms_arn="kmsArn"
)

Attributes

connection_mode

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

Link

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

Return type

str

connector_profile_config

Defines the connector-specific configuration and credentials.

Link

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

Return type

Union[ConnectorProfileConfigProperty, IResolvable, None]

connector_profile_name

The name of the connector profile.

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

Link

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

Return type

str

connector_type

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

Link

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

Return type

str

kms_arn

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.

Link

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

Return type

Optional[str]