CfnConnectorProfile

class aws_cdk.aws_appflow.CfnConnectorProfile(scope, id, *, connection_mode, connector_profile_name, connector_type, connector_profile_config=None, kms_arn=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AppFlow::ConnectorProfile.

The AWS::AppFlow::ConnectorProfile resource is an Amazon AppFlow resource type that specifies the configuration profile for an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. The fields that are common to all types of connector profiles are explicitly specified under the Properties field. The rest of the connector-specific properties are specified under Properties/ConnectorProfileConfig . .. epigraph:

If you want to use AWS CloudFormation to create a connector profile for connectors that implement OAuth (such as Salesforce, Slack, Zendesk, and Google Analytics), you must fetch the access and refresh tokens. You can do this by implementing your own UI for OAuth, or by retrieving the tokens from elsewhere. Alternatively, you can use the Amazon AppFlow console to create the connector profile, and then use that connector profile in the flow creation CloudFormation template.
CloudformationResource

AWS::AppFlow::ConnectorProfile

Link

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

ExampleMetadata

fixture=_generated

Example:

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

# basic_auth_credentials: Any
# o_auth_credentials: Any

cfn_connector_profile = appflow.CfnConnectorProfile(self, "MyCfnConnectorProfile",
    connection_mode="connectionMode",
    connector_profile_name="connectorProfileName",
    connector_type="connectorType",

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

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

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

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

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

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

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

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

Create a new AWS::AppFlow::ConnectorProfile.

Parameters

  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

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

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

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

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

  • kms_arn (Optional[str]) – The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don’t provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters

  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AppFlow::ConnectorProfile'
attr_connector_profile_arn

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

CloudformationAttribute

ConnectorProfileArn

Return type

str

attr_credentials_arn

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

CloudformationAttribute

CredentialsArn

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

connection_mode

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

Link

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

Return type

str

connector_profile_config

Defines the connector-specific configuration and credentials.

Link

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

Return type

Union[ConnectorProfileConfigProperty, IResolvable, None]

connector_profile_name

The name of the connector profile.

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

Link

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

Return type

str

connector_type

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

Link

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

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

kms_arn

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

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

Link

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

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AmplitudeConnectorProfileCredentialsProperty

class CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty(*, api_key, secret_key)

Bases: object

The connector-specific credentials required when using Amplitude.

Parameters

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

amplitude_connector_profile_credentials_property = appflow.CfnConnectorProfile.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.

Link

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

Return type

str

secret_key

The Secret Access Key portion of the credentials.

Link

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

Return type

str

ConnectorOAuthRequestProperty

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

Link

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.
import aws_cdk.aws_appflow as appflow

connector_oAuth_request_property = appflow.CfnConnectorProfile.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.

Link

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

Return type

Optional[str]

redirect_uri

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

Link

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

Return type

Optional[str]

ConnectorProfileConfigProperty

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

Bases: object

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

Parameters
Link

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.
import aws_cdk.aws_appflow as appflow

# basic_auth_credentials: Any
# o_auth_credentials: Any

connector_profile_config_property = appflow.CfnConnectorProfile.ConnectorProfileConfigProperty(
    connector_profile_credentials=appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty(
        amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty(
            api_key="apiKey",
            secret_key="secretKey"
        ),
        datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty(
            api_key="apiKey",
            application_key="applicationKey"
        ),
        dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty(
            api_token="apiToken"
        ),
        google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty(
            client_id="clientId",
            client_secret="clientSecret",

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

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

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

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

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

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

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

Attributes

connector_profile_credentials

The connector-specific credentials required by each connector.

Link

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

Return type

Union[IResolvable, ConnectorProfileCredentialsProperty]

connector_profile_properties

The connector-specific properties of the profile configuration.

Link

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

Return type

Union[IResolvable, ConnectorProfilePropertiesProperty, None]

ConnectorProfileCredentialsProperty

class CfnConnectorProfile.ConnectorProfileCredentialsProperty(*, amplitude=None, datadog=None, dynatrace=None, google_analytics=None, infor_nexus=None, marketo=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
Link

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.
import aws_cdk.aws_appflow as appflow

# basic_auth_credentials: Any
# o_auth_credentials: Any

connector_profile_credentials_property = appflow.CfnConnectorProfile.ConnectorProfileCredentialsProperty(
    amplitude=appflow.CfnConnectorProfile.AmplitudeConnectorProfileCredentialsProperty(
        api_key="apiKey",
        secret_key="secretKey"
    ),
    datadog=appflow.CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty(
        api_key="apiKey",
        application_key="applicationKey"
    ),
    dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty(
        api_token="apiToken"
    ),
    google_analytics=appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty(
        client_id="clientId",
        client_secret="clientSecret",

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

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

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

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

Attributes

amplitude

The connector-specific credentials required when using Amplitude.

Link

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

Return type

Union[IResolvable, AmplitudeConnectorProfileCredentialsProperty, None]

datadog

The connector-specific credentials required when using Datadog.

Link

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

Return type

Union[IResolvable, DatadogConnectorProfileCredentialsProperty, None]

dynatrace

The connector-specific credentials required when using Dynatrace.

Link

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

Return type

Union[IResolvable, DynatraceConnectorProfileCredentialsProperty, None]

google_analytics

The connector-specific credentials required when using Google Analytics.

Link

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

Return type

Union[IResolvable, GoogleAnalyticsConnectorProfileCredentialsProperty, None]

infor_nexus

The connector-specific credentials required when using Infor Nexus.

Link

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

Return type

Union[IResolvable, InforNexusConnectorProfileCredentialsProperty, None]

marketo

The connector-specific credentials required when using Marketo.

Link

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

Return type

Union[IResolvable, MarketoConnectorProfileCredentialsProperty, None]

redshift

The connector-specific credentials required when using Amazon Redshift.

Link

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

Return type

Union[IResolvable, RedshiftConnectorProfileCredentialsProperty, None]

salesforce

The connector-specific credentials required when using Salesforce.

Link

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

Return type

Union[IResolvable, SalesforceConnectorProfileCredentialsProperty, None]

sapo_data

The connector-specific profile credentials required when using SAPOData.

Link

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

Return type

Union[IResolvable, SAPODataConnectorProfileCredentialsProperty, None]

service_now

The connector-specific credentials required when using ServiceNow.

Link

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

Return type

Union[IResolvable, ServiceNowConnectorProfileCredentialsProperty, None]

singular

The connector-specific credentials required when using Singular.

Link

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

Return type

Union[IResolvable, SingularConnectorProfileCredentialsProperty, None]

slack

The connector-specific credentials required when using Slack.

Link

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

Return type

Union[IResolvable, SlackConnectorProfileCredentialsProperty, None]

snowflake

The connector-specific credentials required when using Snowflake.

Link

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

Return type

Union[IResolvable, SnowflakeConnectorProfileCredentialsProperty, None]

trendmicro

The connector-specific credentials required when using Trend Micro.

Link

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

Return type

Union[IResolvable, TrendmicroConnectorProfileCredentialsProperty, None]

veeva

The connector-specific credentials required when using Veeva.

Link

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

Return type

Union[IResolvable, VeevaConnectorProfileCredentialsProperty, None]

zendesk

The connector-specific credentials required when using Zendesk.

Link

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

Return type

Union[IResolvable, ZendeskConnectorProfileCredentialsProperty, None]

ConnectorProfilePropertiesProperty

class CfnConnectorProfile.ConnectorProfilePropertiesProperty(*, datadog=None, dynatrace=None, infor_nexus=None, marketo=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
Link

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.
import aws_cdk.aws_appflow as appflow

connector_profile_properties_property = appflow.CfnConnectorProfile.ConnectorProfilePropertiesProperty(
    datadog=appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    dynatrace=appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    infor_nexus=appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    marketo=appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty(
        instance_url="instanceUrl"
    ),
    redshift=appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty(
        bucket_name="bucketName",
        database_url="databaseUrl",
        role_arn="roleArn",

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

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

Attributes

datadog

The connector-specific properties required by Datadog.

Link

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

Return type

Union[IResolvable, DatadogConnectorProfilePropertiesProperty, None]

dynatrace

The connector-specific properties required by Dynatrace.

Link

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

Return type

Union[IResolvable, DynatraceConnectorProfilePropertiesProperty, None]

infor_nexus

The connector-specific properties required by Infor Nexus.

Link

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

Return type

Union[IResolvable, InforNexusConnectorProfilePropertiesProperty, None]

marketo

The connector-specific properties required by Marketo.

Link

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

Return type

Union[IResolvable, MarketoConnectorProfilePropertiesProperty, None]

redshift

The connector-specific properties required by Amazon Redshift.

Link

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

Return type

Union[IResolvable, RedshiftConnectorProfilePropertiesProperty, None]

salesforce

The connector-specific properties required by Salesforce.

Link

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

Return type

Union[IResolvable, SalesforceConnectorProfilePropertiesProperty, None]

sapo_data

The connector-specific profile properties required when using SAPOData.

Link

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

Return type

Union[IResolvable, SAPODataConnectorProfilePropertiesProperty, None]

service_now

The connector-specific properties required by serviceNow.

Link

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

Return type

Union[IResolvable, ServiceNowConnectorProfilePropertiesProperty, None]

slack

The connector-specific properties required by Slack.

Link

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

Return type

Union[IResolvable, SlackConnectorProfilePropertiesProperty, None]

snowflake

The connector-specific properties required by Snowflake.

Link

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

Return type

Union[IResolvable, SnowflakeConnectorProfilePropertiesProperty, None]

veeva

The connector-specific properties required by Veeva.

Link

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

Return type

Union[IResolvable, VeevaConnectorProfilePropertiesProperty, None]

zendesk

The connector-specific properties required by Zendesk.

Link

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

Return type

Union[IResolvable, ZendeskConnectorProfilePropertiesProperty, None]

DatadogConnectorProfileCredentialsProperty

class CfnConnectorProfile.DatadogConnectorProfileCredentialsProperty(*, api_key, application_key)

Bases: object

The connector-specific credentials required by Datadog.

Parameters

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

  • application_key (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.

Link

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.
import aws_cdk.aws_appflow as appflow

datadog_connector_profile_credentials_property = appflow.CfnConnectorProfile.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.

Link

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

Return type

str

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.

Link

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

Return type

str

DatadogConnectorProfilePropertiesProperty

class CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required by Datadog.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

datadog_connector_profile_properties_property = appflow.CfnConnectorProfile.DatadogConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Datadog resource.

Link

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

Return type

str

DynatraceConnectorProfileCredentialsProperty

class CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty(*, api_token)

Bases: object

The connector-specific profile credentials required by Dynatrace.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

dynatrace_connector_profile_credentials_property = appflow.CfnConnectorProfile.DynatraceConnectorProfileCredentialsProperty(
    api_token="apiToken"
)

Attributes

api_token

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

Link

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

Return type

str

DynatraceConnectorProfilePropertiesProperty

class CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required by Dynatrace.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

dynatrace_connector_profile_properties_property = appflow.CfnConnectorProfile.DynatraceConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Dynatrace resource.

Link

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

Return type

str

GoogleAnalyticsConnectorProfileCredentialsProperty

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

Bases: object

The connector-specific profile credentials required by Google Analytics.

Parameters

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

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

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

  • connector_o_auth_request (Union[IResolvable, ConnectorOAuthRequestProperty, 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.

Link

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.
import aws_cdk.aws_appflow as appflow

google_analytics_connector_profile_credentials_property = appflow.CfnConnectorProfile.GoogleAnalyticsConnectorProfileCredentialsProperty(
    client_id="clientId",
    client_secret="clientSecret",

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

Attributes

access_token

The credentials used to access protected Google Analytics resources.

Link

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

Return type

Optional[str]

client_id

The identifier for the desired client.

Link

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

Return type

str

client_secret

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

Link

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

Return type

str

connector_o_auth_request

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

Link

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

Return type

Union[IResolvable, ConnectorOAuthRequestProperty, None]

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.

Link

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

Return type

Optional[str]

InforNexusConnectorProfileCredentialsProperty

class CfnConnectorProfile.InforNexusConnectorProfileCredentialsProperty(*, access_key_id, datakey, secret_access_key, user_id)

Bases: object

The connector-specific profile credentials required by Infor Nexus.

Parameters

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

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

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

infor_nexus_connector_profile_credentials_property = appflow.CfnConnectorProfile.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.

Link

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

Return type

str

datakey

The encryption keys used to encrypt data.

Link

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

Return type

str

secret_access_key

The secret key used to sign requests.

Link

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

Return type

str

user_id

The identifier for the user.

Link

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

Return type

str

InforNexusConnectorProfilePropertiesProperty

class CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required by Infor Nexus.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

infor_nexus_connector_profile_properties_property = appflow.CfnConnectorProfile.InforNexusConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Infor Nexus resource.

Link

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

Return type

str

MarketoConnectorProfileCredentialsProperty

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

Bases: object

The connector-specific profile credentials required by Marketo.

Parameters

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

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

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

marketo_connector_profile_credentials_property = appflow.CfnConnectorProfile.MarketoConnectorProfileCredentialsProperty(
    client_id="clientId",
    client_secret="clientSecret",

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

Attributes

access_token

The credentials used to access protected Marketo resources.

Link

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

Return type

Optional[str]

client_id

The identifier for the desired client.

Link

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

Return type

str

client_secret

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

Link

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

Return type

str

connector_o_auth_request

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

Link

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

Return type

Union[IResolvable, ConnectorOAuthRequestProperty, None]

MarketoConnectorProfilePropertiesProperty

class CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required when using Marketo.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

marketo_connector_profile_properties_property = appflow.CfnConnectorProfile.MarketoConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Marketo resource.

Link

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

Return type

str

OAuthPropertiesProperty

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

Link

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.
import aws_cdk.aws_appflow as appflow

o_auth_properties_property = appflow.CfnConnectorProfile.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.

Link

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

Return type

Optional[str]

o_auth_scopes

The OAuth scopes required for OAuth type authentication.

Link

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

Return type

Optional[List[str]]

token_url

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

Link

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

Return type

Optional[str]

RedshiftConnectorProfileCredentialsProperty

class CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty(*, password, username)

Bases: object

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

Parameters

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

redshift_connector_profile_credentials_property = appflow.CfnConnectorProfile.RedshiftConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

Link

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

Return type

str

username

The name of the user.

Link

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

Return type

str

RedshiftConnectorProfilePropertiesProperty

class CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty(*, bucket_name, database_url, role_arn, bucket_prefix=None)

Bases: object

The connector-specific profile properties when using Amazon Redshift.

Parameters

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

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

  • role_arn (str) – The Amazon Resource Name (ARN) of the IAM role.

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

Link

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.
import aws_cdk.aws_appflow as appflow

redshift_connector_profile_properties_property = appflow.CfnConnectorProfile.RedshiftConnectorProfilePropertiesProperty(
    bucket_name="bucketName",
    database_url="databaseUrl",
    role_arn="roleArn",

    # the properties below are optional
    bucket_prefix="bucketPrefix"
)

Attributes

bucket_name

A name for the associated Amazon S3 bucket.

Link

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

Return type

str

bucket_prefix

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

Link

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

Return type

Optional[str]

database_url

The JDBC URL of the Amazon Redshift cluster.

Link

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

Return type

str

role_arn

The Amazon Resource Name (ARN) of the IAM role.

Link

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

Return type

str

SAPODataConnectorProfileCredentialsProperty

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

Bases: object

The connector-specific profile credentials required when using SAPOData.

Parameters

  • basic_auth_credentials (Optional[Any]) – The SAPOData basic authentication credentials.

  • o_auth_credentials (Optional[Any]) – The SAPOData OAuth type authentication credentials.

Link

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.
import aws_cdk.aws_appflow as appflow

# basic_auth_credentials: Any
# o_auth_credentials: Any

s_aPOData_connector_profile_credentials_property = appflow.CfnConnectorProfile.SAPODataConnectorProfileCredentialsProperty(
    basic_auth_credentials=basic_auth_credentials,
    o_auth_credentials=o_auth_credentials
)

Attributes

basic_auth_credentials

The SAPOData basic authentication credentials.

Link

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

Return type

Any

o_auth_credentials

The SAPOData OAuth type authentication credentials.

Link

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

Return type

Any

SAPODataConnectorProfilePropertiesProperty

class CfnConnectorProfile.SAPODataConnectorProfilePropertiesProperty(*, application_host_url=None, application_service_path=None, client_number=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.

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

  • o_auth_properties (Union[IResolvable, OAuthPropertiesProperty, 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.

Link

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.
import aws_cdk.aws_appflow as appflow

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

Attributes

application_host_url

The location of the SAPOData resource.

Link

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

Return type

Optional[str]

application_service_path

The application path to catalog service.

Link

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

Return type

Optional[str]

client_number

The client number for the client creating the connection.

Link

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

Return type

Optional[str]

logon_language

The logon language of SAPOData instance.

Link

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

Return type

Optional[str]

o_auth_properties

The SAPOData OAuth properties required for OAuth type authentication.

Link

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

Return type

Union[IResolvable, OAuthPropertiesProperty, None]

port_number

The port number of the SAPOData instance.

Link

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

Return type

Union[int, float, None]

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

Link

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

Return type

Optional[str]

SalesforceConnectorProfileCredentialsProperty

class CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty(*, 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.

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

Link

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.
import aws_cdk.aws_appflow as appflow

salesforce_connector_profile_credentials_property = appflow.CfnConnectorProfile.SalesforceConnectorProfileCredentialsProperty(
    access_token="accessToken",
    client_credentials_arn="clientCredentialsArn",
    connector_oAuth_request=appflow.CfnConnectorProfile.ConnectorOAuthRequestProperty(
        auth_code="authCode",
        redirect_uri="redirectUri"
    ),
    refresh_token="refreshToken"
)

Attributes

access_token

The credentials used to access protected Salesforce resources.

Link

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

Return type

Optional[str]

client_credentials_arn

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

Link

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

Return type

Optional[str]

connector_o_auth_request

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

Link

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

Return type

Union[IResolvable, ConnectorOAuthRequestProperty, None]

refresh_token

The credentials used to acquire new access tokens.

Link

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

Return type

Optional[str]

SalesforceConnectorProfilePropertiesProperty

class CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty(*, instance_url=None, is_sandbox_environment=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.

Link

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.
import aws_cdk.aws_appflow as appflow

salesforce_connector_profile_properties_property = appflow.CfnConnectorProfile.SalesforceConnectorProfilePropertiesProperty(
    instance_url="instanceUrl",
    is_sandbox_environment=False
)

Attributes

instance_url

The location of the Salesforce resource.

Link

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

Return type

Optional[str]

is_sandbox_environment

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

Link

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

Return type

Union[bool, IResolvable, None]

ServiceNowConnectorProfileCredentialsProperty

class CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty(*, password, username)

Bases: object

The connector-specific profile credentials required when using ServiceNow.

Parameters

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

service_now_connector_profile_credentials_property = appflow.CfnConnectorProfile.ServiceNowConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

Link

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

Return type

str

username

The name of the user.

Link

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

Return type

str

ServiceNowConnectorProfilePropertiesProperty

class CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required when using ServiceNow.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

service_now_connector_profile_properties_property = appflow.CfnConnectorProfile.ServiceNowConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the ServiceNow resource.

Link

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

Return type

str

SingularConnectorProfileCredentialsProperty

class CfnConnectorProfile.SingularConnectorProfileCredentialsProperty(*, api_key)

Bases: object

The connector-specific profile credentials required when using Singular.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

singular_connector_profile_credentials_property = appflow.CfnConnectorProfile.SingularConnectorProfileCredentialsProperty(
    api_key="apiKey"
)

Attributes

api_key

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

Link

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

Return type

str

SlackConnectorProfileCredentialsProperty

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

Bases: object

The connector-specific profile credentials required when using Slack.

Parameters

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

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

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

slack_connector_profile_credentials_property = appflow.CfnConnectorProfile.SlackConnectorProfileCredentialsProperty(
    client_id="clientId",
    client_secret="clientSecret",

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

Attributes

access_token

The credentials used to access protected Slack resources.

Link

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

Return type

Optional[str]

client_id

The identifier for the client.

Link

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

Return type

str

client_secret

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

Link

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

Return type

str

connector_o_auth_request

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

Link

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

Return type

Union[IResolvable, ConnectorOAuthRequestProperty, None]

SlackConnectorProfilePropertiesProperty

class CfnConnectorProfile.SlackConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required when using Slack.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

slack_connector_profile_properties_property = appflow.CfnConnectorProfile.SlackConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Slack resource.

Link

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

Return type

str

SnowflakeConnectorProfileCredentialsProperty

class CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty(*, password, username)

Bases: object

The connector-specific profile credentials required when using Snowflake.

Parameters

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

snowflake_connector_profile_credentials_property = appflow.CfnConnectorProfile.SnowflakeConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

Link

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

Return type

str

username

The name of the user.

Link

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

Return type

str

SnowflakeConnectorProfilePropertiesProperty

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

Bases: object

The connector-specific profile properties required when using Snowflake.

Parameters

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

  • stage (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 (str) – The name of the Snowflake warehouse.

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

snowflake_connector_profile_properties_property = appflow.CfnConnectorProfile.SnowflakeConnectorProfilePropertiesProperty(
    bucket_name="bucketName",
    stage="stage",
    warehouse="warehouse",

    # the properties below are optional
    account_name="accountName",
    bucket_prefix="bucketPrefix",
    private_link_service_name="privateLinkServiceName",
    region="region"
)

Attributes

account_name

The name of the account.

Link

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

Return type

Optional[str]

bucket_name

The name of the Amazon S3 bucket associated with Snowflake.

Link

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

Return type

str

bucket_prefix

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

Link

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

Return type

Optional[str]

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

Link

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

Return type

Optional[str]

region

The AWS Region of the Snowflake account.

Link

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

Return type

Optional[str]

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

Link

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

Return type

str

warehouse

The name of the Snowflake warehouse.

Link

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

Return type

str

TrendmicroConnectorProfileCredentialsProperty

class CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty(*, api_secret_key)

Bases: object

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

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

trendmicro_connector_profile_credentials_property = appflow.CfnConnectorProfile.TrendmicroConnectorProfileCredentialsProperty(
    api_secret_key="apiSecretKey"
)

Attributes

api_secret_key

The Secret Access Key portion of the credentials.

Link

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

Return type

str

VeevaConnectorProfileCredentialsProperty

class CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty(*, password, username)

Bases: object

The connector-specific profile credentials required when using Veeva.

Parameters

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

veeva_connector_profile_credentials_property = appflow.CfnConnectorProfile.VeevaConnectorProfileCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password that corresponds to the user name.

Link

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

Return type

str

username

The name of the user.

Link

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

Return type

str

VeevaConnectorProfilePropertiesProperty

class CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required when using Veeva.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

veeva_connector_profile_properties_property = appflow.CfnConnectorProfile.VeevaConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Veeva resource.

Link

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

Return type

str

ZendeskConnectorProfileCredentialsProperty

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

Bases: object

The connector-specific profile credentials required when using Zendesk.

Parameters

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

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

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

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

Link

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.
import aws_cdk.aws_appflow as appflow

zendesk_connector_profile_credentials_property = appflow.CfnConnectorProfile.ZendeskConnectorProfileCredentialsProperty(
    client_id="clientId",
    client_secret="clientSecret",

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

Attributes

access_token

The credentials used to access protected Zendesk resources.

Link

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

Return type

Optional[str]

client_id

The identifier for the desired client.

Link

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

Return type

str

client_secret

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

Link

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

Return type

str

connector_o_auth_request

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

Link

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

Return type

Union[IResolvable, ConnectorOAuthRequestProperty, None]

ZendeskConnectorProfilePropertiesProperty

class CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty(*, instance_url)

Bases: object

The connector-specific profile properties required when using Zendesk.

Parameters

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

Link

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.
import aws_cdk.aws_appflow as appflow

zendesk_connector_profile_properties_property = appflow.CfnConnectorProfile.ZendeskConnectorProfilePropertiesProperty(
    instance_url="instanceUrl"
)

Attributes

instance_url

The location of the Zendesk resource.

Link

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

Return type

str