CfnConnectorProfilePropsMixin

class aws_cdk.mixins_preview.aws_appflow.mixins.CfnConnectorProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

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

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

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_connector_profile_props_mixin = appflow_mixins.CfnConnectorProfilePropsMixin(appflow_mixins.CfnConnectorProfileMixinProps(
    connection_mode="connectionMode",
    connector_label="connectorLabel",
    connector_profile_config=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileConfigProperty(
        connector_profile_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty(
            amplitude=appflow_mixins.CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty(
                api_key="apiKey",
                secret_key="secretKey"
            ),
            custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty(
                api_key=appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(
                    api_key="apiKey",
                    api_secret_key="apiSecretKey"
                ),
                authentication_type="authenticationType",
                basic=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
                    password="password",
                    username="username"
                ),
                custom=appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(
                    credentials_map={
                        "credentials_map_key": "credentialsMap"
                    },
                    custom_authentication_type="customAuthenticationType"
                ),
                oauth2=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
                    access_token="accessToken",
                    client_id="clientId",
                    client_secret="clientSecret",
                    o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                        auth_code="authCode",
                        redirect_uri="redirectUri"
                    ),
                    refresh_token="refreshToken"
                )
            ),
            datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty(
                api_key="apiKey",
                application_key="applicationKey"
            ),
            dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty(
                api_token="apiToken"
            ),
            google_analytics=appflow_mixins.CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            ),
            infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty(
                access_key_id="accessKeyId",
                datakey="datakey",
                secret_access_key="secretAccessKey",
                user_id="userId"
            ),
            marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            ),
            pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_credentials_arn="clientCredentialsArn",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            ),
            redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_credentials_arn="clientCredentialsArn",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                jwt_token="jwtToken",
                o_auth2_grant_type="oAuth2GrantType",
                refresh_token="refreshToken"
            ),
            sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty(
                basic_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
                    password="password",
                    username="username"
                ),
                o_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(
                    access_token="accessToken",
                    client_id="clientId",
                    client_secret="clientSecret",
                    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                        auth_code="authCode",
                        redirect_uri="redirectUri"
                    ),
                    refresh_token="refreshToken"
                )
            ),
            service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty(
                o_auth2_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
                    access_token="accessToken",
                    client_id="clientId",
                    client_secret="clientSecret",
                    o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                        auth_code="authCode",
                        redirect_uri="redirectUri"
                    ),
                    refresh_token="refreshToken"
                ),
                password="password",
                username="username"
            ),
            singular=appflow_mixins.CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty(
                api_key="apiKey"
            ),
            slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            ),
            snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            trendmicro=appflow_mixins.CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty(
                api_secret_key="apiSecretKey"
            ),
            veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty(
                password="password",
                username="username"
            ),
            zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                )
            )
        ),
        connector_profile_properties=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty(
            custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty(
                o_auth2_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(
                    o_auth2_grant_type="oAuth2GrantType",
                    token_url="tokenUrl",
                    token_url_custom_properties={
                        "token_url_custom_properties_key": "tokenUrlCustomProperties"
                    }
                ),
                profile_properties={
                    "profile_properties_key": "profileProperties"
                }
            ),
            datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty(
                business_unit_id="businessUnitId",
                instance_url="instanceUrl",
                is_sandbox_environment=False
            ),
            redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty(
                bucket_name="bucketName",
                bucket_prefix="bucketPrefix",
                cluster_identifier="clusterIdentifier",
                data_api_role_arn="dataApiRoleArn",
                database_name="databaseName",
                database_url="databaseUrl",
                is_redshift_serverless=False,
                role_arn="roleArn",
                workgroup_name="workgroupName"
            ),
            salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty(
                instance_url="instanceUrl",
                is_sandbox_environment=False,
                use_private_link_for_metadata_and_authorization=False
            ),
            sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty(
                application_host_url="applicationHostUrl",
                application_service_path="applicationServicePath",
                client_number="clientNumber",
                disable_sso=False,
                logon_language="logonLanguage",
                o_auth_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(
                    auth_code_url="authCodeUrl",
                    o_auth_scopes=["oAuthScopes"],
                    token_url="tokenUrl"
                ),
                port_number=123,
                private_link_service_name="privateLinkServiceName"
            ),
            service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty(
                account_name="accountName",
                bucket_name="bucketName",
                bucket_prefix="bucketPrefix",
                private_link_service_name="privateLinkServiceName",
                region="region",
                stage="stage",
                warehouse="warehouse"
            ),
            veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            ),
            zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty(
                instance_url="instanceUrl"
            )
        )
    ),
    connector_profile_name="connectorProfileName",
    connector_type="connectorType",
    kms_arn="kmsArn"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

• props (Union[CfnConnectorProfileMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['connectionMode', 'connectorLabel', 'connectorProfileConfig', 'connectorProfileName', 'connectorType', 'kmsArn']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AmplitudeConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty(*, api_key=None, secret_key=None)

Bases: object

The connector-specific credentials required when using Amplitude.

Parameters:

• api_key (Optional[str]) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

• secret_key (Optional[str]) – The Secret Access Key portion of the credentials.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

amplitude_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty(
    api_key="apiKey",
    secret_key="secretKey"
)

Attributes

api_key

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-apikey

secret_key

The Secret Access Key portion of the credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-amplitudeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-amplitudeconnectorprofilecredentials-secretkey

ApiKeyCredentialsProperty

class CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(*, api_key=None, api_secret_key=None)

Bases: object

The API key credentials required for API key authentication.

Parameters:

• api_key (Optional[str]) – The API key required for API key authentication.

• api_secret_key (Optional[str]) – The API secret key required for API key authentication.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

api_key_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(
    api_key="apiKey",
    api_secret_key="apiSecretKey"
)

Attributes

api_key

The API key required for API key authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apikey

api_secret_key

The API secret key required for API key authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-apikeycredentials.html#cfn-appflow-connectorprofile-apikeycredentials-apisecretkey

BasicAuthCredentialsProperty

class CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(*, password=None, username=None)

Bases: object

The basic auth credentials required for basic authentication.

Parameters:

• password (Optional[str]) – The password to use to connect to a resource.

• username (Optional[str]) – The username to use to connect to a resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

basic_auth_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password to use to connect to a resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html#cfn-appflow-connectorprofile-basicauthcredentials-password

username

The username to use to connect to a resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-basicauthcredentials.html#cfn-appflow-connectorprofile-basicauthcredentials-username

ConnectorOAuthRequestProperty

class CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(*, auth_code=None, redirect_uri=None)

Bases: object

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Parameters:

• auth_code (Optional[str]) – The code provided by the connector when it has been authenticated via the connected app.

• redirect_uri (Optional[str]) – The URL to which the authentication server redirects the browser after authorization has been granted.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

connector_oAuth_request_property = appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
    auth_code="authCode",
    redirect_uri="redirectUri"
)

Attributes

auth_code

The code provided by the connector when it has been authenticated via the connected app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html#cfn-appflow-connectorprofile-connectoroauthrequest-authcode

redirect_uri

The URL to which the authentication server redirects the browser after authorization has been granted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectoroauthrequest.html#cfn-appflow-connectorprofile-connectoroauthrequest-redirecturi

ConnectorProfileConfigProperty

class CfnConnectorProfilePropsMixin.ConnectorProfileConfigProperty(*, connector_profile_credentials=None, connector_profile_properties=None)

Bases: object

Defines the connector-specific configuration and credentials for the connector profile.

Parameters:

• connector_profile_credentials (Union[IResolvable, ConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required by each connector.

• connector_profile_properties (Union[IResolvable, ConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties of the profile configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

connector_profile_config_property = appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileConfigProperty(
    connector_profile_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty(
        amplitude=appflow_mixins.CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty(
            api_key="apiKey",
            secret_key="secretKey"
        ),
        custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty(
            api_key=appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(
                api_key="apiKey",
                api_secret_key="apiSecretKey"
            ),
            authentication_type="authenticationType",
            basic=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
                password="password",
                username="username"
            ),
            custom=appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(
                credentials_map={
                    "credentials_map_key": "credentialsMap"
                },
                custom_authentication_type="customAuthenticationType"
            ),
            oauth2=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            )
        ),
        datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty(
            api_key="apiKey",
            application_key="applicationKey"
        ),
        dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty(
            api_token="apiToken"
        ),
        google_analytics=appflow_mixins.CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            refresh_token="refreshToken"
        ),
        infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty(
            access_key_id="accessKeyId",
            datakey="datakey",
            secret_access_key="secretAccessKey",
            user_id="userId"
        ),
        marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            )
        ),
        pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_credentials_arn="clientCredentialsArn",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            refresh_token="refreshToken"
        ),
        redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty(
            password="password",
            username="username"
        ),
        salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_credentials_arn="clientCredentialsArn",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            jwt_token="jwtToken",
            o_auth2_grant_type="oAuth2GrantType",
            refresh_token="refreshToken"
        ),
        sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty(
            basic_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
                password="password",
                username="username"
            ),
            o_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            )
        ),
        service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty(
            o_auth2_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
                access_token="accessToken",
                client_id="clientId",
                client_secret="clientSecret",
                o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                    auth_code="authCode",
                    redirect_uri="redirectUri"
                ),
                refresh_token="refreshToken"
            ),
            password="password",
            username="username"
        ),
        singular=appflow_mixins.CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty(
            api_key="apiKey"
        ),
        slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            )
        ),
        snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty(
            password="password",
            username="username"
        ),
        trendmicro=appflow_mixins.CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty(
            api_secret_key="apiSecretKey"
        ),
        veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty(
            password="password",
            username="username"
        ),
        zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            )
        )
    ),
    connector_profile_properties=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty(
        custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty(
            o_auth2_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(
                o_auth2_grant_type="oAuth2GrantType",
                token_url="tokenUrl",
                token_url_custom_properties={
                    "token_url_custom_properties_key": "tokenUrlCustomProperties"
                }
            ),
            profile_properties={
                "profile_properties_key": "profileProperties"
            }
        ),
        datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty(
            business_unit_id="businessUnitId",
            instance_url="instanceUrl",
            is_sandbox_environment=False
        ),
        redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",
            cluster_identifier="clusterIdentifier",
            data_api_role_arn="dataApiRoleArn",
            database_name="databaseName",
            database_url="databaseUrl",
            is_redshift_serverless=False,
            role_arn="roleArn",
            workgroup_name="workgroupName"
        ),
        salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty(
            instance_url="instanceUrl",
            is_sandbox_environment=False,
            use_private_link_for_metadata_and_authorization=False
        ),
        sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty(
            application_host_url="applicationHostUrl",
            application_service_path="applicationServicePath",
            client_number="clientNumber",
            disable_sso=False,
            logon_language="logonLanguage",
            o_auth_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(
                auth_code_url="authCodeUrl",
                o_auth_scopes=["oAuthScopes"],
                token_url="tokenUrl"
            ),
            port_number=123,
            private_link_service_name="privateLinkServiceName"
        ),
        service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty(
            account_name="accountName",
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix",
            private_link_service_name="privateLinkServiceName",
            region="region",
            stage="stage",
            warehouse="warehouse"
        ),
        veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        ),
        zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty(
            instance_url="instanceUrl"
        )
    )
)

Attributes

connector_profile_credentials

The connector-specific credentials required by each connector.

See:

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

connector_profile_properties

The connector-specific properties of the profile configuration.

See:

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

ConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty(*, amplitude=None, custom_connector=None, datadog=None, dynatrace=None, google_analytics=None, infor_nexus=None, marketo=None, pardot=None, redshift=None, salesforce=None, sapo_data=None, service_now=None, singular=None, slack=None, snowflake=None, trendmicro=None, veeva=None, zendesk=None)

Bases: object

The connector-specific credentials required by a connector.

Parameters:

• amplitude (Union[IResolvable, AmplitudeConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Amplitude.

• custom_connector (Union[IResolvable, CustomConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific profile credentials that are required when using the custom connector.

• datadog (Union[IResolvable, DatadogConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Datadog.

• dynatrace (Union[IResolvable, DynatraceConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Dynatrace.

• google_analytics (Union[IResolvable, GoogleAnalyticsConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Google Analytics.

• infor_nexus (Union[IResolvable, InforNexusConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Infor Nexus.

• marketo (Union[IResolvable, MarketoConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Marketo.

• pardot (Union[IResolvable, PardotConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Salesforce Pardot.

• redshift (Union[IResolvable, RedshiftConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Amazon Redshift.

• salesforce (Union[IResolvable, SalesforceConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Salesforce.

• sapo_data (Union[IResolvable, SAPODataConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific profile credentials required when using SAPOData.

• service_now (Union[IResolvable, ServiceNowConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using ServiceNow.

• singular (Union[IResolvable, SingularConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Singular.

• slack (Union[IResolvable, SlackConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Slack.

• snowflake (Union[IResolvable, SnowflakeConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Snowflake.

• trendmicro (Union[IResolvable, TrendmicroConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Trend Micro.

• veeva (Union[IResolvable, VeevaConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Veeva.

• zendesk (Union[IResolvable, ZendeskConnectorProfileCredentialsProperty, Dict[str, Any], None]) – The connector-specific credentials required when using Zendesk.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfileCredentialsProperty(
    amplitude=appflow_mixins.CfnConnectorProfilePropsMixin.AmplitudeConnectorProfileCredentialsProperty(
        api_key="apiKey",
        secret_key="secretKey"
    ),
    custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty(
        api_key=appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(
            api_key="apiKey",
            api_secret_key="apiSecretKey"
        ),
        authentication_type="authenticationType",
        basic=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
            password="password",
            username="username"
        ),
        custom=appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(
            credentials_map={
                "credentials_map_key": "credentialsMap"
            },
            custom_authentication_type="customAuthenticationType"
        ),
        oauth2=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            refresh_token="refreshToken"
        )
    ),
    datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty(
        api_key="apiKey",
        application_key="applicationKey"
    ),
    dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty(
        api_token="apiToken"
    ),
    google_analytics=appflow_mixins.CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        refresh_token="refreshToken"
    ),
    infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty(
        access_key_id="accessKeyId",
        datakey="datakey",
        secret_access_key="secretAccessKey",
        user_id="userId"
    ),
    marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        )
    ),
    pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_credentials_arn="clientCredentialsArn",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        refresh_token="refreshToken"
    ),
    redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty(
        password="password",
        username="username"
    ),
    salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_credentials_arn="clientCredentialsArn",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        jwt_token="jwtToken",
        o_auth2_grant_type="oAuth2GrantType",
        refresh_token="refreshToken"
    ),
    sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty(
        basic_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
            password="password",
            username="username"
        ),
        o_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            refresh_token="refreshToken"
        )
    ),
    service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty(
        o_auth2_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
            access_token="accessToken",
            client_id="clientId",
            client_secret="clientSecret",
            o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
                auth_code="authCode",
                redirect_uri="redirectUri"
            ),
            refresh_token="refreshToken"
        ),
        password="password",
        username="username"
    ),
    singular=appflow_mixins.CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty(
        api_key="apiKey"
    ),
    slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        )
    ),
    snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty(
        password="password",
        username="username"
    ),
    trendmicro=appflow_mixins.CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty(
        api_secret_key="apiSecretKey"
    ),
    veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty(
        password="password",
        username="username"
    ),
    zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        )
    )
)

Attributes

amplitude

The connector-specific credentials required when using Amplitude.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-amplitude

custom_connector

The connector-specific profile credentials that are required when using the custom connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-customconnector

datadog

The connector-specific credentials required when using Datadog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-datadog

dynatrace

The connector-specific credentials required when using Dynatrace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-dynatrace

google_analytics

The connector-specific credentials required when using Google Analytics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-googleanalytics

infor_nexus

The connector-specific credentials required when using Infor Nexus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-infornexus

marketo

The connector-specific credentials required when using Marketo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-marketo

pardot

The connector-specific credentials required when using Salesforce Pardot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-pardot

redshift

The connector-specific credentials required when using Amazon Redshift.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-redshift

salesforce

The connector-specific credentials required when using Salesforce.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-salesforce

sapo_data

The connector-specific profile credentials required when using SAPOData.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-sapodata

service_now

The connector-specific credentials required when using ServiceNow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-servicenow

singular

The connector-specific credentials required when using Singular.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-singular

slack

The connector-specific credentials required when using Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-slack

snowflake

The connector-specific credentials required when using Snowflake.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-snowflake

trendmicro

The connector-specific credentials required when using Trend Micro.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-trendmicro

veeva

The connector-specific credentials required when using Veeva.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-veeva

zendesk

The connector-specific credentials required when using Zendesk.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofilecredentials.html#cfn-appflow-connectorprofile-connectorprofilecredentials-zendesk

ConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty(*, custom_connector=None, datadog=None, dynatrace=None, infor_nexus=None, marketo=None, pardot=None, redshift=None, salesforce=None, sapo_data=None, service_now=None, slack=None, snowflake=None, veeva=None, zendesk=None)

Bases: object

The connector-specific profile properties required by each connector.

Parameters:

• custom_connector (Union[IResolvable, CustomConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The properties required by the custom connector.

• datadog (Union[IResolvable, DatadogConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Datadog.

• dynatrace (Union[IResolvable, DynatraceConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Dynatrace.

• infor_nexus (Union[IResolvable, InforNexusConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Infor Nexus.

• marketo (Union[IResolvable, MarketoConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Marketo.

• pardot (Union[IResolvable, PardotConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Salesforce Pardot.

• redshift (Union[IResolvable, RedshiftConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Amazon Redshift.

• salesforce (Union[IResolvable, SalesforceConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Salesforce.

• sapo_data (Union[IResolvable, SAPODataConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific profile properties required when using SAPOData.

• service_now (Union[IResolvable, ServiceNowConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by serviceNow.

• slack (Union[IResolvable, SlackConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Slack.

• snowflake (Union[IResolvable, SnowflakeConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Snowflake.

• veeva (Union[IResolvable, VeevaConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Veeva.

• zendesk (Union[IResolvable, ZendeskConnectorProfilePropertiesProperty, Dict[str, Any], None]) – The connector-specific properties required by Zendesk.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorProfilePropertiesProperty(
    custom_connector=appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty(
        o_auth2_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(
            o_auth2_grant_type="oAuth2GrantType",
            token_url="tokenUrl",
            token_url_custom_properties={
                "token_url_custom_properties_key": "tokenUrlCustomProperties"
            }
        ),
        profile_properties={
            "profile_properties_key": "profileProperties"
        }
    ),
    datadog=appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    dynatrace=appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    infor_nexus=appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    marketo=appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    pardot=appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty(
        business_unit_id="businessUnitId",
        instance_url="instanceUrl",
        is_sandbox_environment=False
    ),
    redshift=appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty(
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix",
        cluster_identifier="clusterIdentifier",
        data_api_role_arn="dataApiRoleArn",
        database_name="databaseName",
        database_url="databaseUrl",
        is_redshift_serverless=False,
        role_arn="roleArn",
        workgroup_name="workgroupName"
    ),
    salesforce=appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty(
        instance_url="instanceUrl",
        is_sandbox_environment=False,
        use_private_link_for_metadata_and_authorization=False
    ),
    sapo_data=appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty(
        application_host_url="applicationHostUrl",
        application_service_path="applicationServicePath",
        client_number="clientNumber",
        disable_sso=False,
        logon_language="logonLanguage",
        o_auth_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(
            auth_code_url="authCodeUrl",
            o_auth_scopes=["oAuthScopes"],
            token_url="tokenUrl"
        ),
        port_number=123,
        private_link_service_name="privateLinkServiceName"
    ),
    service_now=appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    slack=appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    snowflake=appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty(
        account_name="accountName",
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix",
        private_link_service_name="privateLinkServiceName",
        region="region",
        stage="stage",
        warehouse="warehouse"
    ),
    veeva=appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    zendesk=appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    )
)

Attributes

custom_connector

The properties required by the custom connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-customconnector

datadog

The connector-specific properties required by Datadog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-datadog

dynatrace

The connector-specific properties required by Dynatrace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-dynatrace

infor_nexus

The connector-specific properties required by Infor Nexus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-infornexus

marketo

The connector-specific properties required by Marketo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-marketo

pardot

The connector-specific properties required by Salesforce Pardot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-pardot

redshift

The connector-specific properties required by Amazon Redshift.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-redshift

salesforce

The connector-specific properties required by Salesforce.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-salesforce

sapo_data

The connector-specific profile properties required when using SAPOData.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-sapodata

service_now

The connector-specific properties required by serviceNow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-servicenow

slack

The connector-specific properties required by Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-slack

snowflake

The connector-specific properties required by Snowflake.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-snowflake

veeva

The connector-specific properties required by Veeva.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-veeva

zendesk

The connector-specific properties required by Zendesk.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-connectorprofileproperties.html#cfn-appflow-connectorprofile-connectorprofileproperties-zendesk

CustomAuthCredentialsProperty

class CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(*, credentials_map=None, custom_authentication_type=None)

Bases: object

The custom credentials required for custom authentication.

Parameters:

• credentials_map (Union[Mapping[str, str], IResolvable, None]) – A map that holds custom authentication credentials.

• custom_authentication_type (Optional[str]) – The custom authentication type that the connector uses.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

custom_auth_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(
    credentials_map={
        "credentials_map_key": "credentialsMap"
    },
    custom_authentication_type="customAuthenticationType"
)

Attributes

credentials_map

A map that holds custom authentication credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html#cfn-appflow-connectorprofile-customauthcredentials-credentialsmap

custom_authentication_type

The custom authentication type that the connector uses.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customauthcredentials.html#cfn-appflow-connectorprofile-customauthcredentials-customauthenticationtype

CustomConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty(*, api_key=None, authentication_type=None, basic=None, custom=None, oauth2=None)

Bases: object

The connector-specific profile credentials that are required when using the custom connector.

Parameters:

• api_key (Union[IResolvable, ApiKeyCredentialsProperty, Dict[str, Any], None]) – The API keys required for the authentication of the user.

• authentication_type (Optional[str]) – The authentication type that the custom connector uses for authenticating while creating a connector profile.

• basic (Union[IResolvable, BasicAuthCredentialsProperty, Dict[str, Any], None]) – The basic credentials that are required for the authentication of the user.

• custom (Union[IResolvable, CustomAuthCredentialsProperty, Dict[str, Any], None]) – If the connector uses the custom authentication mechanism, this holds the required credentials.

• oauth2 (Union[IResolvable, OAuth2CredentialsProperty, Dict[str, Any], None]) – The OAuth 2.0 credentials required for the authentication of the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

custom_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfileCredentialsProperty(
    api_key=appflow_mixins.CfnConnectorProfilePropsMixin.ApiKeyCredentialsProperty(
        api_key="apiKey",
        api_secret_key="apiSecretKey"
    ),
    authentication_type="authenticationType",
    basic=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
        password="password",
        username="username"
    ),
    custom=appflow_mixins.CfnConnectorProfilePropsMixin.CustomAuthCredentialsProperty(
        credentials_map={
            "credentials_map_key": "credentialsMap"
        },
        custom_authentication_type="customAuthenticationType"
    ),
    oauth2=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        refresh_token="refreshToken"
    )
)

Attributes

api_key

The API keys required for the authentication of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-apikey

authentication_type

The authentication type that the custom connector uses for authenticating while creating a connector profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-authenticationtype

basic

The basic credentials that are required for the authentication of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-basic

custom

If the connector uses the custom authentication mechanism, this holds the required credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-custom

oauth2

The OAuth 2.0 credentials required for the authentication of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofilecredentials.html#cfn-appflow-connectorprofile-customconnectorprofilecredentials-oauth2

CustomConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty(*, o_auth2_properties=None, profile_properties=None)

Bases: object

The profile properties required by the custom connector.

Parameters:

• o_auth2_properties (Union[IResolvable, OAuth2PropertiesProperty, Dict[str, Any], None]) – The OAuth 2.0 properties required for OAuth 2.0 authentication.

• profile_properties (Union[Mapping[str, str], IResolvable, None]) – A map of properties that are required to create a profile for the custom connector.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

custom_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.CustomConnectorProfilePropertiesProperty(
    o_auth2_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(
        o_auth2_grant_type="oAuth2GrantType",
        token_url="tokenUrl",
        token_url_custom_properties={
            "token_url_custom_properties_key": "tokenUrlCustomProperties"
        }
    ),
    profile_properties={
        "profile_properties_key": "profileProperties"
    }
)

Attributes

o_auth2_properties

The OAuth 2.0 properties required for OAuth 2.0 authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html#cfn-appflow-connectorprofile-customconnectorprofileproperties-oauth2properties

profile_properties

A map of properties that are required to create a profile for the custom connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-customconnectorprofileproperties.html#cfn-appflow-connectorprofile-customconnectorprofileproperties-profileproperties

DatadogConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty(*, api_key=None, application_key=None)

Bases: object

The connector-specific credentials required by Datadog.

Parameters:

• api_key (Optional[str]) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

• application_key (Optional[str]) – Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

datadog_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfileCredentialsProperty(
    api_key="apiKey",
    application_key="applicationKey"
)

Attributes

api_key

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-apikey

application_key

Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API.

Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofilecredentials.html#cfn-appflow-connectorprofile-datadogconnectorprofilecredentials-applicationkey

DatadogConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required by Datadog.

Parameters:

instance_url (Optional[str]) – The location of the Datadog resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

datadog_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.DatadogConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Datadog resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-datadogconnectorprofileproperties.html#cfn-appflow-connectorprofile-datadogconnectorprofileproperties-instanceurl

DynatraceConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty(*, api_token=None)

Bases: object

The connector-specific profile credentials required by Dynatrace.

Parameters:

api_token (Optional[str]) – The API tokens used by Dynatrace API to authenticate various API calls.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

dynatrace_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfileCredentialsProperty(
    api_token="apiToken"
)

Attributes

api_token

The API tokens used by Dynatrace API to authenticate various API calls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-dynatraceconnectorprofilecredentials-apitoken

DynatraceConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required by Dynatrace.

Parameters:

instance_url (Optional[str]) – The location of the Dynatrace resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

dynatrace_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.DynatraceConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Dynatrace resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-dynatraceconnectorprofileproperties.html#cfn-appflow-connectorprofile-dynatraceconnectorprofileproperties-instanceurl

GoogleAnalyticsConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty(*, access_token=None, client_id=None, client_secret=None, connector_o_auth_request=None, refresh_token=None)

Bases: object

The connector-specific profile credentials required by Google Analytics.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Google Analytics resources.

• client_id (Optional[str]) – The identifier for the desired client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

• refresh_token (Optional[str]) – The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

google_analytics_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.GoogleAnalyticsConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    refresh_token="refreshToken"
)

Attributes

access_token

The credentials used to access protected Google Analytics resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-accesstoken

client_id

The identifier for the desired client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-clientsecret

connector_o_auth_request

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-connectoroauthrequest

refresh_token

The credentials used to acquire new access tokens.

This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials.html#cfn-appflow-connectorprofile-googleanalyticsconnectorprofilecredentials-refreshtoken

InforNexusConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty(*, access_key_id=None, datakey=None, secret_access_key=None, user_id=None)

Bases: object

The connector-specific profile credentials required by Infor Nexus.

Parameters:

• access_key_id (Optional[str]) – The Access Key portion of the credentials.

• datakey (Optional[str]) – The encryption keys used to encrypt data.

• secret_access_key (Optional[str]) – The secret key used to sign requests.

• user_id (Optional[str]) – The identifier for the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

infor_nexus_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfileCredentialsProperty(
    access_key_id="accessKeyId",
    datakey="datakey",
    secret_access_key="secretAccessKey",
    user_id="userId"
)

Attributes

access_key_id

The Access Key portion of the credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-accesskeyid

datakey

The encryption keys used to encrypt data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-datakey

secret_access_key

The secret key used to sign requests.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-secretaccesskey

user_id

The identifier for the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofilecredentials.html#cfn-appflow-connectorprofile-infornexusconnectorprofilecredentials-userid

InforNexusConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required by Infor Nexus.

Parameters:

instance_url (Optional[str]) – The location of the Infor Nexus resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

infor_nexus_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.InforNexusConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Infor Nexus resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-infornexusconnectorprofileproperties.html#cfn-appflow-connectorprofile-infornexusconnectorprofileproperties-instanceurl

MarketoConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty(*, access_token=None, client_id=None, client_secret=None, connector_o_auth_request=None)

Bases: object

The connector-specific profile credentials required by Marketo.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Marketo resources.

• client_id (Optional[str]) – The identifier for the desired client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

marketo_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    )
)

Attributes

access_token

The credentials used to access protected Marketo resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-accesstoken

client_id

The identifier for the desired client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-clientsecret

connector_o_auth_request

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofilecredentials.html#cfn-appflow-connectorprofile-marketoconnectorprofilecredentials-connectoroauthrequest

MarketoConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required when using Marketo.

Parameters:

instance_url (Optional[str]) – The location of the Marketo resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

marketo_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.MarketoConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Marketo resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-marketoconnectorprofileproperties.html#cfn-appflow-connectorprofile-marketoconnectorprofileproperties-instanceurl

OAuth2CredentialsProperty

class CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(*, access_token=None, client_id=None, client_secret=None, o_auth_request=None, refresh_token=None)

Bases: object

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Parameters:

• access_token (Optional[str]) – The access token used to access the connector on your behalf.

• client_id (Optional[str]) – The identifier for the desired client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None])

• refresh_token (Optional[str]) – The refresh token used to refresh an expired access token.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

o_auth2_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    refresh_token="refreshToken"
)

Attributes

access_token

The access token used to access the connector on your behalf.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-accesstoken

client_id

The identifier for the desired client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-clientsecret

o_auth_request

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-oauthrequest

Type:

see

refresh_token

The refresh token used to refresh an expired access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2credentials.html#cfn-appflow-connectorprofile-oauth2credentials-refreshtoken

OAuth2PropertiesProperty

class CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(*, o_auth2_grant_type=None, token_url=None, token_url_custom_properties=None)

Bases: object

The OAuth 2.0 properties required for OAuth 2.0 authentication.

Parameters:

• o_auth2_grant_type (Optional[str]) – The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

• token_url (Optional[str]) – The token URL required for OAuth 2.0 authentication.

• token_url_custom_properties (Union[Mapping[str, str], IResolvable, None]) – Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

o_auth2_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2PropertiesProperty(
    o_auth2_grant_type="oAuth2GrantType",
    token_url="tokenUrl",
    token_url_custom_properties={
        "token_url_custom_properties_key": "tokenUrlCustomProperties"
    }
)

Attributes

o_auth2_grant_type

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-oauth2granttype

token_url

The token URL required for OAuth 2.0 authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-tokenurl

token_url_custom_properties

Associates your token URL with a map of properties that you define.

Use this parameter to provide any additional details that the connector requires to authenticate your request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauth2properties.html#cfn-appflow-connectorprofile-oauth2properties-tokenurlcustomproperties

OAuthCredentialsProperty

class CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(*, access_token=None, client_id=None, client_secret=None, connector_o_auth_request=None, refresh_token=None)

Bases: object

The OAuth credentials required for OAuth type authentication.

Parameters:

• access_token (Optional[str]) – The access token used to access protected SAPOData resources.

• client_id (Optional[str]) – The identifier for the desired client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None])

• refresh_token (Optional[str]) – The refresh token used to refresh expired access token.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

o_auth_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    refresh_token="refreshToken"
)

Attributes

access_token

The access token used to access protected SAPOData resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-accesstoken

client_id

The identifier for the desired client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-clientsecret

connector_o_auth_request

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-connectoroauthrequest

Type:

see

refresh_token

The refresh token used to refresh expired access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthcredentials.html#cfn-appflow-connectorprofile-oauthcredentials-refreshtoken

OAuthPropertiesProperty

class CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(*, auth_code_url=None, o_auth_scopes=None, token_url=None)

Bases: object

The OAuth properties required for OAuth type authentication.

Parameters:

• auth_code_url (Optional[str]) – The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.

• o_auth_scopes (Optional[Sequence[str]]) – The OAuth scopes required for OAuth type authentication.

• token_url (Optional[str]) – The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

o_auth_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(
    auth_code_url="authCodeUrl",
    o_auth_scopes=["oAuthScopes"],
    token_url="tokenUrl"
)

Attributes

auth_code_url

The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-authcodeurl

o_auth_scopes

The OAuth scopes required for OAuth type authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-oauthscopes

token_url

The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-oauthproperties.html#cfn-appflow-connectorprofile-oauthproperties-tokenurl

PardotConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty(*, access_token=None, client_credentials_arn=None, connector_o_auth_request=None, refresh_token=None)

Bases: object

The connector-specific profile credentials required when using Salesforce Pardot.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Salesforce Pardot resources.

• client_credentials_arn (Optional[str]) – The secret manager ARN, which contains the client ID and client secret of the connected app.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None])

• refresh_token (Optional[str]) – The credentials used to acquire new access tokens.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pardot_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_credentials_arn="clientCredentialsArn",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    refresh_token="refreshToken"
)

Attributes

access_token

The credentials used to access protected Salesforce Pardot resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-accesstoken

client_credentials_arn

The secret manager ARN, which contains the client ID and client secret of the connected app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-clientcredentialsarn

connector_o_auth_request

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-connectoroauthrequest

Type:

see

refresh_token

The credentials used to acquire new access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofilecredentials.html#cfn-appflow-connectorprofile-pardotconnectorprofilecredentials-refreshtoken

PardotConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty(*, business_unit_id=None, instance_url=None, is_sandbox_environment=None)

Bases: object

The connector-specific profile properties required when using Salesforce Pardot.

Parameters:

• business_unit_id (Optional[str]) – The business unit id of Salesforce Pardot instance.

• instance_url (Optional[str]) – The location of the Salesforce Pardot resource.

• is_sandbox_environment (Union[bool, IResolvable, None]) – Indicates whether the connector profile applies to a sandbox or production environment.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pardot_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.PardotConnectorProfilePropertiesProperty(
    business_unit_id="businessUnitId",
    instance_url="instanceUrl",
    is_sandbox_environment=False
)

Attributes

business_unit_id

The business unit id of Salesforce Pardot instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-businessunitid

instance_url

The location of the Salesforce Pardot resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-instanceurl

is_sandbox_environment

Indicates whether the connector profile applies to a sandbox or production environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-pardotconnectorprofileproperties.html#cfn-appflow-connectorprofile-pardotconnectorprofileproperties-issandboxenvironment

RedshiftConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty(*, password=None, username=None)

Bases: object

The connector-specific profile credentials required when using Amazon Redshift.

Parameters:

• password (Optional[str]) – The password that corresponds to the user name.

• username (Optional[str]) – The name of the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

redshift_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-password

username

The name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofilecredentials.html#cfn-appflow-connectorprofile-redshiftconnectorprofilecredentials-username

RedshiftConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty(*, bucket_name=None, bucket_prefix=None, cluster_identifier=None, data_api_role_arn=None, database_name=None, database_url=None, is_redshift_serverless=None, role_arn=None, workgroup_name=None)

Bases: object

The connector-specific profile properties when using Amazon Redshift.

Parameters:

• bucket_name (Optional[str]) – A name for the associated Amazon S3 bucket.

• bucket_prefix (Optional[str]) – The object key for the destination bucket in which Amazon AppFlow places the files.

• cluster_identifier (Optional[str]) – The unique ID that’s assigned to an Amazon Redshift cluster.

• data_api_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .

• database_name (Optional[str]) – The name of an Amazon Redshift database.

• database_url (Optional[str]) – The JDBC URL of the Amazon Redshift cluster.

• is_redshift_serverless (Union[bool, IResolvable, None]) – Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

• role_arn (Optional[str]) – The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .

• workgroup_name (Optional[str]) – The name of an Amazon Redshift workgroup.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

redshift_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.RedshiftConnectorProfilePropertiesProperty(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    cluster_identifier="clusterIdentifier",
    data_api_role_arn="dataApiRoleArn",
    database_name="databaseName",
    database_url="databaseUrl",
    is_redshift_serverless=False,
    role_arn="roleArn",
    workgroup_name="workgroupName"
)

Attributes

bucket_name

A name for the associated Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketname

bucket_prefix

The object key for the destination bucket in which Amazon AppFlow places the files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-bucketprefix

cluster_identifier

The unique ID that’s assigned to an Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-clusteridentifier

data_api_role_arn

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API.

For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-dataapirolearn

database_name

The name of an Amazon Redshift database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databasename

database_url

The JDBC URL of the Amazon Redshift cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-databaseurl

is_redshift_serverless

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-isredshiftserverless

role_arn

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3.

For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-rolearn

workgroup_name

The name of an Amazon Redshift workgroup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-redshiftconnectorprofileproperties.html#cfn-appflow-connectorprofile-redshiftconnectorprofileproperties-workgroupname

SAPODataConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty(*, basic_auth_credentials=None, o_auth_credentials=None)

Bases: object

The connector-specific profile credentials required when using SAPOData.

Parameters:

• basic_auth_credentials (Union[IResolvable, BasicAuthCredentialsProperty, Dict[str, Any], None]) – The SAPOData basic authentication credentials.

• o_auth_credentials (Union[IResolvable, OAuthCredentialsProperty, Dict[str, Any], None]) – The SAPOData OAuth type authentication credentials.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s_aPOData_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfileCredentialsProperty(
    basic_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.BasicAuthCredentialsProperty(
        password="password",
        username="username"
    ),
    o_auth_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthCredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        refresh_token="refreshToken"
    )
)

Attributes

basic_auth_credentials

The SAPOData basic authentication credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-basicauthcredentials

o_auth_credentials

The SAPOData OAuth type authentication credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofilecredentials.html#cfn-appflow-connectorprofile-sapodataconnectorprofilecredentials-oauthcredentials

SAPODataConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty(*, application_host_url=None, application_service_path=None, client_number=None, disable_sso=None, logon_language=None, o_auth_properties=None, port_number=None, private_link_service_name=None)

Bases: object

The connector-specific profile properties required when using SAPOData.

Parameters:

• application_host_url (Optional[str]) – The location of the SAPOData resource.

• application_service_path (Optional[str]) – The application path to catalog service.

• client_number (Optional[str]) – The client number for the client creating the connection.

• disable_sso (Union[bool, IResolvable, None]) – If you set this parameter to true , Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance. Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.

• logon_language (Optional[str]) – The logon language of SAPOData instance.

• o_auth_properties (Union[IResolvable, OAuthPropertiesProperty, Dict[str, Any], None]) – The SAPOData OAuth properties required for OAuth type authentication.

• port_number (Union[int, float, None]) – The port number of the SAPOData instance.

• private_link_service_name (Optional[str]) – The SAPOData Private Link service name to be used for private data transfers.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

s_aPOData_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.SAPODataConnectorProfilePropertiesProperty(
    application_host_url="applicationHostUrl",
    application_service_path="applicationServicePath",
    client_number="clientNumber",
    disable_sso=False,
    logon_language="logonLanguage",
    o_auth_properties=appflow_mixins.CfnConnectorProfilePropsMixin.OAuthPropertiesProperty(
        auth_code_url="authCodeUrl",
        o_auth_scopes=["oAuthScopes"],
        token_url="tokenUrl"
    ),
    port_number=123,
    private_link_service_name="privateLinkServiceName"
)

Attributes

application_host_url

The location of the SAPOData resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationhosturl

application_service_path

The application path to catalog service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-applicationservicepath

client_number

The client number for the client creating the connection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-clientnumber

disable_sso

If you set this parameter to true , Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-disablesso

logon_language

The logon language of SAPOData instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-logonlanguage

o_auth_properties

The SAPOData OAuth properties required for OAuth type authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-oauthproperties

port_number

The port number of the SAPOData instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-portnumber

private_link_service_name

The SAPOData Private Link service name to be used for private data transfers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-sapodataconnectorprofileproperties.html#cfn-appflow-connectorprofile-sapodataconnectorprofileproperties-privatelinkservicename

SalesforceConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty(*, access_token=None, client_credentials_arn=None, connector_o_auth_request=None, jwt_token=None, o_auth2_grant_type=None, refresh_token=None)

Bases: object

The connector-specific profile credentials required when using Salesforce.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Salesforce resources.

• client_credentials_arn (Optional[str]) – The secret manager ARN, which contains the client ID and client secret of the connected app.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

• jwt_token (Optional[str]) – A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

• o_auth2_grant_type (Optional[str]) – Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records. You can specify one of the following values: - AUTHORIZATION_CODE - Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records. - JWT_BEARER - Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don’t need to log in to your Salesforce account to authorize Amazon AppFlow to access your records. .. epigraph:: The CLIENT_CREDENTIALS value is not supported for Salesforce.

• refresh_token (Optional[str]) – The credentials used to acquire new access tokens.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

salesforce_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_credentials_arn="clientCredentialsArn",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    jwt_token="jwtToken",
    o_auth2_grant_type="oAuth2GrantType",
    refresh_token="refreshToken"
)

Attributes

access_token

The credentials used to access protected Salesforce resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-accesstoken

client_credentials_arn

The secret manager ARN, which contains the client ID and client secret of the connected app.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-clientcredentialsarn

connector_o_auth_request

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-connectoroauthrequest

jwt_token

A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-jwttoken

o_auth2_grant_type

Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

You can specify one of the following values:

• AUTHORIZATION_CODE - Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

• JWT_BEARER - Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don’t need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

The CLIENT_CREDENTIALS value is not supported for Salesforce.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-oauth2granttype

refresh_token

The credentials used to acquire new access tokens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofilecredentials.html#cfn-appflow-connectorprofile-salesforceconnectorprofilecredentials-refreshtoken

SalesforceConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty(*, instance_url=None, is_sandbox_environment=None, use_private_link_for_metadata_and_authorization=None)

Bases: object

The connector-specific profile properties required when using Salesforce.

Parameters:

• instance_url (Optional[str]) – The location of the Salesforce resource.

• is_sandbox_environment (Union[bool, IResolvable, None]) – Indicates whether the connector profile applies to a sandbox or production environment.

• use_private_link_for_metadata_and_authorization (Union[bool, IResolvable, None]) – If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through AWS PrivateLink . These calls travel through AWS infrastructure without being exposed to the public internet. Set either of the following values: - true - Amazon AppFlow sends all calls to Salesforce over the private network. These private calls are: - Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields. - Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records. - Calls to transfer your Salesforce records as part of a flow run. - false - The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet. The public calls are: - Calls to get metadata about your Salesforce records. - Calls to get or refresh access tokens. The private calls are: - Calls to transfer your Salesforce records as part of a flow run.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

salesforce_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.SalesforceConnectorProfilePropertiesProperty(
    instance_url="instanceUrl",
    is_sandbox_environment=False,
    use_private_link_for_metadata_and_authorization=False
)

Attributes

instance_url

The location of the Salesforce resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-instanceurl

is_sandbox_environment

Indicates whether the connector profile applies to a sandbox or production environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-issandboxenvironment

use_private_link_for_metadata_and_authorization

If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce.

Amazon AppFlow sends private calls through AWS PrivateLink . These calls travel through AWS infrastructure without being exposed to the public internet.

Set either of the following values:

• true - Amazon AppFlow sends all calls to Salesforce over the private network.

These private calls are:

• Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.

• Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.

• Calls to transfer your Salesforce records as part of a flow run.

• false - The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

The public calls are:

• Calls to get metadata about your Salesforce records.

• Calls to get or refresh access tokens.

The private calls are:

• Calls to transfer your Salesforce records as part of a flow run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-salesforceconnectorprofileproperties.html#cfn-appflow-connectorprofile-salesforceconnectorprofileproperties-useprivatelinkformetadataandauthorization

ServiceNowConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty(*, o_auth2_credentials=None, password=None, username=None)

Bases: object

The connector-specific profile credentials required when using ServiceNow.

Parameters:

• o_auth2_credentials (Union[IResolvable, OAuth2CredentialsProperty, Dict[str, Any], None]) – The OAuth 2.0 credentials required to authenticate the user.

• password (Optional[str]) – The password that corresponds to the user name.

• username (Optional[str]) – The name of the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

service_now_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfileCredentialsProperty(
    o_auth2_credentials=appflow_mixins.CfnConnectorProfilePropsMixin.OAuth2CredentialsProperty(
        access_token="accessToken",
        client_id="clientId",
        client_secret="clientSecret",
        o_auth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
            auth_code="authCode",
            redirect_uri="redirectUri"
        ),
        refresh_token="refreshToken"
    ),
    password="password",
    username="username"
)

Attributes

o_auth2_credentials

The OAuth 2.0 credentials required to authenticate the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-oauth2credentials

password

The password that corresponds to the user name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-password

username

The name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofilecredentials.html#cfn-appflow-connectorprofile-servicenowconnectorprofilecredentials-username

ServiceNowConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required when using ServiceNow.

Parameters:

instance_url (Optional[str]) – The location of the ServiceNow resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

service_now_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.ServiceNowConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the ServiceNow resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-servicenowconnectorprofileproperties.html#cfn-appflow-connectorprofile-servicenowconnectorprofileproperties-instanceurl

SingularConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty(*, api_key=None)

Bases: object

The connector-specific profile credentials required when using Singular.

Parameters:

api_key (Optional[str]) – A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

singular_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.SingularConnectorProfileCredentialsProperty(
    api_key="apiKey"
)

Attributes

api_key

A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-singularconnectorprofilecredentials.html#cfn-appflow-connectorprofile-singularconnectorprofilecredentials-apikey

SlackConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty(*, access_token=None, client_id=None, client_secret=None, connector_o_auth_request=None)

Bases: object

The connector-specific profile credentials required when using Slack.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Slack resources.

• client_id (Optional[str]) – The identifier for the client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

slack_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    )
)

Attributes

access_token

The credentials used to access protected Slack resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-accesstoken

client_id

The identifier for the client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-clientsecret

connector_o_auth_request

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofilecredentials.html#cfn-appflow-connectorprofile-slackconnectorprofilecredentials-connectoroauthrequest

SlackConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required when using Slack.

Parameters:

instance_url (Optional[str]) – The location of the Slack resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

slack_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.SlackConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Slack resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-slackconnectorprofileproperties.html#cfn-appflow-connectorprofile-slackconnectorprofileproperties-instanceurl

SnowflakeConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty(*, password=None, username=None)

Bases: object

The connector-specific profile credentials required when using Snowflake.

Parameters:

• password (Optional[str]) – The password that corresponds to the user name.

• username (Optional[str]) – The name of the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

snowflake_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-password

username

The name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofilecredentials.html#cfn-appflow-connectorprofile-snowflakeconnectorprofilecredentials-username

SnowflakeConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty(*, account_name=None, bucket_name=None, bucket_prefix=None, private_link_service_name=None, region=None, stage=None, warehouse=None)

Bases: object

The connector-specific profile properties required when using Snowflake.

Parameters:

• account_name (Optional[str]) – The name of the account.

• bucket_name (Optional[str]) – The name of the Amazon S3 bucket associated with Snowflake.

• bucket_prefix (Optional[str]) – The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

• private_link_service_name (Optional[str]) – The Snowflake Private Link service name to be used for private data transfers.

• region (Optional[str]) – The AWS Region of the Snowflake account.

• stage (Optional[str]) – The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema>.

• warehouse (Optional[str]) – The name of the Snowflake warehouse.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

snowflake_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.SnowflakeConnectorProfilePropertiesProperty(
    account_name="accountName",
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix",
    private_link_service_name="privateLinkServiceName",
    region="region",
    stage="stage",
    warehouse="warehouse"
)

Attributes

account_name

The name of the account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-accountname

bucket_name

The name of the Amazon S3 bucket associated with Snowflake.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketname

bucket_prefix

The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-bucketprefix

private_link_service_name

The Snowflake Private Link service name to be used for private data transfers.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-privatelinkservicename

region

The AWS Region of the Snowflake account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-region

stage

The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account.

This is written in the following format: < Database>< Schema>.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-stage

warehouse

The name of the Snowflake warehouse.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-snowflakeconnectorprofileproperties.html#cfn-appflow-connectorprofile-snowflakeconnectorprofileproperties-warehouse

TrendmicroConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty(*, api_secret_key=None)

Bases: object

The connector-specific profile credentials required when using Trend Micro.

Parameters:

api_secret_key (Optional[str]) – The Secret Access Key portion of the credentials.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

trendmicro_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.TrendmicroConnectorProfileCredentialsProperty(
    api_secret_key="apiSecretKey"
)

Attributes

api_secret_key

The Secret Access Key portion of the credentials.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-trendmicroconnectorprofilecredentials.html#cfn-appflow-connectorprofile-trendmicroconnectorprofilecredentials-apisecretkey

VeevaConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty(*, password=None, username=None)

Bases: object

The connector-specific profile credentials required when using Veeva.

Parameters:

• password (Optional[str]) – The password that corresponds to the user name.

• username (Optional[str]) – The name of the user.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

veeva_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-password

username

The name of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofilecredentials.html#cfn-appflow-connectorprofile-veevaconnectorprofilecredentials-username

VeevaConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required when using Veeva.

Parameters:

instance_url (Optional[str]) – The location of the Veeva resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

veeva_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.VeevaConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Veeva resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-veevaconnectorprofileproperties.html#cfn-appflow-connectorprofile-veevaconnectorprofileproperties-instanceurl

ZendeskConnectorProfileCredentialsProperty

class CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty(*, access_token=None, client_id=None, client_secret=None, connector_o_auth_request=None)

Bases: object

The connector-specific profile credentials required when using Zendesk.

Parameters:

• access_token (Optional[str]) – The credentials used to access protected Zendesk resources.

• client_id (Optional[str]) – The identifier for the desired client.

• client_secret (Optional[str]) – The client secret used by the OAuth client to authenticate to the authorization server.

• connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, Dict[str, Any], None]) – Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

zendesk_connector_profile_credentials_property = appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_id="clientId",
    client_secret="clientSecret",
    connector_oAuth_request=appflow_mixins.CfnConnectorProfilePropsMixin.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    )
)

Attributes

access_token

The credentials used to access protected Zendesk resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-accesstoken

client_id

The identifier for the desired client.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientid

client_secret

The client secret used by the OAuth client to authenticate to the authorization server.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-clientsecret

connector_o_auth_request

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofilecredentials.html#cfn-appflow-connectorprofile-zendeskconnectorprofilecredentials-connectoroauthrequest

ZendeskConnectorProfilePropertiesProperty

class CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty(*, instance_url=None)

Bases: object

The connector-specific profile properties required when using Zendesk.

Parameters:

instance_url (Optional[str]) – The location of the Zendesk resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

zendesk_connector_profile_properties_property = appflow_mixins.CfnConnectorProfilePropsMixin.ZendeskConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Zendesk resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appflow-connectorprofile-zendeskconnectorprofileproperties.html#cfn-appflow-connectorprofile-zendeskconnectorprofileproperties-instanceurl