CfnIntegration

class aws_cdk.aws_customerprofiles.CfnIntegration(scope, id, *, domain_name, flow_definition=None, object_type_name=None, object_type_names=None, tags=None, uri=None)

Bases: CfnResource

A CloudFormation AWS::CustomerProfiles::Integration.

Specifies an Amazon Connect Customer Profiles Integration.

CloudformationResource:

AWS::CustomerProfiles::Integration

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.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_customerprofiles as customerprofiles

cfn_integration = customerprofiles.CfnIntegration(self, "MyCfnIntegration",
    domain_name="domainName",

    # the properties below are optional
    flow_definition=customerprofiles.CfnIntegration.FlowDefinitionProperty(
        flow_name="flowName",
        kms_arn="kmsArn",
        source_flow_config=customerprofiles.CfnIntegration.SourceFlowConfigProperty(
            connector_type="connectorType",
            source_connector_properties=customerprofiles.CfnIntegration.SourceConnectorPropertiesProperty(
                marketo=customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty(
                    object="object"
                ),
                s3=customerprofiles.CfnIntegration.S3SourcePropertiesProperty(
                    bucket_name="bucketName",

                    # the properties below are optional
                    bucket_prefix="bucketPrefix"
                ),
                salesforce=customerprofiles.CfnIntegration.SalesforceSourcePropertiesProperty(
                    object="object",

                    # the properties below are optional
                    enable_dynamic_field_update=False,
                    include_deleted_records=False
                ),
                service_now=customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty(
                    object="object"
                ),
                zendesk=customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty(
                    object="object"
                )
            ),

            # the properties below are optional
            connector_profile_name="connectorProfileName",
            incremental_pull_config=customerprofiles.CfnIntegration.IncrementalPullConfigProperty(
                datetime_type_field_name="datetimeTypeFieldName"
            )
        ),
        tasks=[customerprofiles.CfnIntegration.TaskProperty(
            source_fields=["sourceFields"],
            task_type="taskType",

            # the properties below are optional
            connector_operator=customerprofiles.CfnIntegration.ConnectorOperatorProperty(
                marketo="marketo",
                s3="s3",
                salesforce="salesforce",
                service_now="serviceNow",
                zendesk="zendesk"
            ),
            destination_field="destinationField",
            task_properties=[customerprofiles.CfnIntegration.TaskPropertiesMapProperty(
                operator_property_key="operatorPropertyKey",
                property="property"
            )]
        )],
        trigger_config=customerprofiles.CfnIntegration.TriggerConfigProperty(
            trigger_type="triggerType",

            # the properties below are optional
            trigger_properties=customerprofiles.CfnIntegration.TriggerPropertiesProperty(
                scheduled=customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty(
                    schedule_expression="scheduleExpression",

                    # the properties below are optional
                    data_pull_mode="dataPullMode",
                    first_execution_from=123,
                    schedule_end_time=123,
                    schedule_offset=123,
                    schedule_start_time=123,
                    timezone="timezone"
                )
            )
        ),

        # the properties below are optional
        description="description"
    ),
    object_type_name="objectTypeName",
    object_type_names=[customerprofiles.CfnIntegration.ObjectTypeMappingProperty(
        key="key",
        value="value"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri="uri"
)

Create a new AWS::CustomerProfiles::Integration.

Parameters:

  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • domain_name (str) – The unique name of the domain.

  • flow_definition (Union[FlowDefinitionProperty, Dict[str, Any], IResolvable, None]) – The configuration that controls how Customer Profiles retrieves data from the source.

  • object_type_name (Optional[str]) – The name of the profile object type mapping to use.

  • object_type_names (Union[IResolvable, Sequence[Union[IResolvable, ObjectTypeMappingProperty, Dict[str, Any]]], None]) – The object type mapping.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

  • uri (Optional[str]) – The URI of the S3 bucket or any other type of data source.

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:

Return type:

None

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.

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:

Return type:

Any

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.

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::CustomerProfiles::Integration'
attr_created_at

The timestamp of when the integration was created.

CloudformationAttribute:

CreatedAt

attr_last_updated_at

The timestamp of when the integration was most recently edited.

CloudformationAttribute:

LastUpdatedAt

cfn_options

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

cfn_resource_type

AWS resource type.

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.

domain_name

The unique name of the domain.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-domainname

flow_definition

The configuration that controls how Customer Profiles retrieves data from the source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-flowdefinition

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

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.

object_type_name

The name of the profile object type mapping to use.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypename

object_type_names

The object type mapping.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypenames

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

stack

The stack in which this element is defined.

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

tags

The tags used to organize, track, or control access for this resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-tags

uri

The URI of the S3 bucket or any other type of data source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-uri

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

ConnectorOperatorProperty

class CfnIntegration.ConnectorOperatorProperty(*, marketo=None, s3=None, salesforce=None, service_now=None, zendesk=None)

Bases: object

The operation to be performed on the provided source fields.

Parameters:

  • marketo (Optional[str]) – The operation to be performed on the provided Marketo source fields.

  • s3 (Optional[str]) – The operation to be performed on the provided Amazon S3 source fields.

  • salesforce (Optional[str]) – The operation to be performed on the provided Salesforce source fields.

  • service_now (Optional[str]) – The operation to be performed on the provided ServiceNow source fields.

  • zendesk (Optional[str]) – The operation to be performed on the provided Zendesk source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.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_customerprofiles as customerprofiles

connector_operator_property = customerprofiles.CfnIntegration.ConnectorOperatorProperty(
    marketo="marketo",
    s3="s3",
    salesforce="salesforce",
    service_now="serviceNow",
    zendesk="zendesk"
)

Attributes

marketo

The operation to be performed on the provided Marketo source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-marketo

s3

The operation to be performed on the provided Amazon S3 source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-s3

salesforce

The operation to be performed on the provided Salesforce source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-salesforce

service_now

The operation to be performed on the provided ServiceNow source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-servicenow

zendesk

The operation to be performed on the provided Zendesk source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-zendesk

FlowDefinitionProperty

class CfnIntegration.FlowDefinitionProperty(*, flow_name, kms_arn, source_flow_config, tasks, trigger_config, description=None)

Bases: object

The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.

Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

Parameters:

  • flow_name (str) – The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.

  • kms_arn (str) – The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.

  • source_flow_config (Union[IResolvable, SourceFlowConfigProperty, Dict[str, Any]]) – The configuration that controls how Customer Profiles retrieves data from the source.

  • tasks (Union[IResolvable, Sequence[Union[IResolvable, TaskProperty, Dict[str, Any]]]]) – A list of tasks that Customer Profiles performs while transferring the data in the flow run.

  • trigger_config (Union[IResolvable, TriggerConfigProperty, Dict[str, Any]]) – The trigger settings that determine how and when the flow runs.

  • description (Optional[str]) – A description of the flow you want to create.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.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_customerprofiles as customerprofiles

flow_definition_property = customerprofiles.CfnIntegration.FlowDefinitionProperty(
    flow_name="flowName",
    kms_arn="kmsArn",
    source_flow_config=customerprofiles.CfnIntegration.SourceFlowConfigProperty(
        connector_type="connectorType",
        source_connector_properties=customerprofiles.CfnIntegration.SourceConnectorPropertiesProperty(
            marketo=customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty(
                object="object"
            ),
            s3=customerprofiles.CfnIntegration.S3SourcePropertiesProperty(
                bucket_name="bucketName",

                # the properties below are optional
                bucket_prefix="bucketPrefix"
            ),
            salesforce=customerprofiles.CfnIntegration.SalesforceSourcePropertiesProperty(
                object="object",

                # the properties below are optional
                enable_dynamic_field_update=False,
                include_deleted_records=False
            ),
            service_now=customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty(
                object="object"
            ),
            zendesk=customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty(
                object="object"
            )
        ),

        # the properties below are optional
        connector_profile_name="connectorProfileName",
        incremental_pull_config=customerprofiles.CfnIntegration.IncrementalPullConfigProperty(
            datetime_type_field_name="datetimeTypeFieldName"
        )
    ),
    tasks=[customerprofiles.CfnIntegration.TaskProperty(
        source_fields=["sourceFields"],
        task_type="taskType",

        # the properties below are optional
        connector_operator=customerprofiles.CfnIntegration.ConnectorOperatorProperty(
            marketo="marketo",
            s3="s3",
            salesforce="salesforce",
            service_now="serviceNow",
            zendesk="zendesk"
        ),
        destination_field="destinationField",
        task_properties=[customerprofiles.CfnIntegration.TaskPropertiesMapProperty(
            operator_property_key="operatorPropertyKey",
            property="property"
        )]
    )],
    trigger_config=customerprofiles.CfnIntegration.TriggerConfigProperty(
        trigger_type="triggerType",

        # the properties below are optional
        trigger_properties=customerprofiles.CfnIntegration.TriggerPropertiesProperty(
            scheduled=customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty(
                schedule_expression="scheduleExpression",

                # the properties below are optional
                data_pull_mode="dataPullMode",
                first_execution_from=123,
                schedule_end_time=123,
                schedule_offset=123,
                schedule_start_time=123,
                timezone="timezone"
            )
        )
    ),

    # the properties below are optional
    description="description"
)

Attributes

description

A description of the flow you want to create.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-description

flow_name

The specified name of the flow.

Use underscores (_) or hyphens (-) only. Spaces are not allowed.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-flowname

kms_arn

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-kmsarn

source_flow_config

The configuration that controls how Customer Profiles retrieves data from the source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig

tasks

A list of tasks that Customer Profiles performs while transferring the data in the flow run.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-tasks

trigger_config

The trigger settings that determine how and when the flow runs.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-triggerconfig

IncrementalPullConfigProperty

class CfnIntegration.IncrementalPullConfigProperty(*, datetime_type_field_name=None)

Bases: object

Specifies the configuration used when importing incremental records from the source.

Parameters:

datetime_type_field_name (Optional[str]) – A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.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_customerprofiles as customerprofiles

incremental_pull_config_property = customerprofiles.CfnIntegration.IncrementalPullConfigProperty(
    datetime_type_field_name="datetimeTypeFieldName"
)

Attributes

datetime_type_field_name

A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html#cfn-customerprofiles-integration-incrementalpullconfig-datetimetypefieldname

MarketoSourcePropertiesProperty

class CfnIntegration.MarketoSourcePropertiesProperty(*, object)

Bases: object

The properties that are applied when Marketo is being used as a source.

Parameters:

object (str) – The object specified in the Marketo flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.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_customerprofiles as customerprofiles

marketo_source_properties_property = customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the Marketo flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html#cfn-customerprofiles-integration-marketosourceproperties-object

ObjectTypeMappingProperty

class CfnIntegration.ObjectTypeMappingProperty(*, key, value)

Bases: object

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.

Parameters:

  • key (str) – The key.

  • value (str) – The value.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.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_customerprofiles as customerprofiles

object_type_mapping_property = customerprofiles.CfnIntegration.ObjectTypeMappingProperty(
    key="key",
    value="value"
)

Attributes

key

The key.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-key

value

The value.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-value

S3SourcePropertiesProperty

class CfnIntegration.S3SourcePropertiesProperty(*, bucket_name, bucket_prefix=None)

Bases: object

The properties that are applied when Amazon S3 is being used as the flow source.

Parameters:

  • bucket_name (str) – The Amazon S3 bucket name where the source files are stored.

  • bucket_prefix (Optional[str]) – The object key for the Amazon S3 bucket in which the source files are stored.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.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_customerprofiles as customerprofiles

s3_source_properties_property = customerprofiles.CfnIntegration.S3SourcePropertiesProperty(
    bucket_name="bucketName",

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

Attributes

bucket_name

The Amazon S3 bucket name where the source files are stored.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketname

bucket_prefix

The object key for the Amazon S3 bucket in which the source files are stored.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketprefix

SalesforceSourcePropertiesProperty

class CfnIntegration.SalesforceSourcePropertiesProperty(*, object, enable_dynamic_field_update=None, include_deleted_records=None)

Bases: object

The properties that are applied when Salesforce is being used as a source.

Parameters:

  • object (str) – The object specified in the Salesforce flow source.

  • enable_dynamic_field_update (Union[bool, IResolvable, None]) – The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

  • include_deleted_records (Union[bool, IResolvable, None]) – Indicates whether Amazon AppFlow includes deleted files in the flow run.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.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_customerprofiles as customerprofiles

salesforce_source_properties_property = customerprofiles.CfnIntegration.SalesforceSourcePropertiesProperty(
    object="object",

    # the properties below are optional
    enable_dynamic_field_update=False,
    include_deleted_records=False
)

Attributes

enable_dynamic_field_update

The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-enabledynamicfieldupdate

include_deleted_records

Indicates whether Amazon AppFlow includes deleted files in the flow run.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-includedeletedrecords

object

The object specified in the Salesforce flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-object

ScheduledTriggerPropertiesProperty

class CfnIntegration.ScheduledTriggerPropertiesProperty(*, schedule_expression, data_pull_mode=None, first_execution_from=None, schedule_end_time=None, schedule_offset=None, schedule_start_time=None, timezone=None)

Bases: object

Specifies the configuration details of a scheduled-trigger flow that you define.

Currently, these settings only apply to the scheduled-trigger type.

Parameters:

  • schedule_expression (str) – The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

  • data_pull_mode (Optional[str]) – Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

  • first_execution_from (Union[int, float, None]) – Specifies the date range for the records to import from the connector in the first flow run.

  • schedule_end_time (Union[int, float, None]) – Specifies the scheduled end time for a scheduled-trigger flow.

  • schedule_offset (Union[int, float, None]) – Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

  • schedule_start_time (Union[int, float, None]) – Specifies the scheduled start time for a scheduled-trigger flow.

  • timezone (Optional[str]) – Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.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_customerprofiles as customerprofiles

scheduled_trigger_properties_property = customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty(
    schedule_expression="scheduleExpression",

    # the properties below are optional
    data_pull_mode="dataPullMode",
    first_execution_from=123,
    schedule_end_time=123,
    schedule_offset=123,
    schedule_start_time=123,
    timezone="timezone"
)

Attributes

data_pull_mode

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-datapullmode

first_execution_from

Specifies the date range for the records to import from the connector in the first flow run.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-firstexecutionfrom

schedule_end_time

Specifies the scheduled end time for a scheduled-trigger flow.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleendtime

schedule_expression

The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleexpression

schedule_offset

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleoffset

schedule_start_time

Specifies the scheduled start time for a scheduled-trigger flow.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-schedulestarttime

timezone

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-timezone

ServiceNowSourcePropertiesProperty

class CfnIntegration.ServiceNowSourcePropertiesProperty(*, object)

Bases: object

The properties that are applied when ServiceNow is being used as a source.

Parameters:

object (str) – The object specified in the ServiceNow flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.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_customerprofiles as customerprofiles

service_now_source_properties_property = customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the ServiceNow flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html#cfn-customerprofiles-integration-servicenowsourceproperties-object

SourceConnectorPropertiesProperty

class CfnIntegration.SourceConnectorPropertiesProperty(*, marketo=None, s3=None, salesforce=None, service_now=None, zendesk=None)

Bases: object

Specifies the information that is required to query a particular Amazon AppFlow connector.

Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.

Parameters:
Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.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_customerprofiles as customerprofiles

source_connector_properties_property = customerprofiles.CfnIntegration.SourceConnectorPropertiesProperty(
    marketo=customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty(
        object="object"
    ),
    s3=customerprofiles.CfnIntegration.S3SourcePropertiesProperty(
        bucket_name="bucketName",

        # the properties below are optional
        bucket_prefix="bucketPrefix"
    ),
    salesforce=customerprofiles.CfnIntegration.SalesforceSourcePropertiesProperty(
        object="object",

        # the properties below are optional
        enable_dynamic_field_update=False,
        include_deleted_records=False
    ),
    service_now=customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty(
        object="object"
    ),
    zendesk=customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty(
        object="object"
    )
)

Attributes

marketo

The properties that are applied when Marketo is being used as a source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-marketo

s3

The properties that are applied when Amazon S3 is being used as the flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-s3

salesforce

The properties that are applied when Salesforce is being used as a source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-salesforce

service_now

The properties that are applied when ServiceNow is being used as a source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-servicenow

zendesk

The properties that are applied when using Zendesk as a flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-zendesk

SourceFlowConfigProperty

class CfnIntegration.SourceFlowConfigProperty(*, connector_type, source_connector_properties, connector_profile_name=None, incremental_pull_config=None)

Bases: object

The configuration that controls how Customer Profiles retrieves data from the source.

Parameters:

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

  • source_connector_properties (Union[IResolvable, SourceConnectorPropertiesProperty, Dict[str, Any]]) – Specifies the information that is required to query a particular source connector.

  • connector_profile_name (Optional[str]) – The name of the Amazon AppFlow connector profile. This name must be unique for each connector profile in the AWS account .

  • incremental_pull_config (Union[IResolvable, IncrementalPullConfigProperty, Dict[str, Any], None]) – Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.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_customerprofiles as customerprofiles

source_flow_config_property = customerprofiles.CfnIntegration.SourceFlowConfigProperty(
    connector_type="connectorType",
    source_connector_properties=customerprofiles.CfnIntegration.SourceConnectorPropertiesProperty(
        marketo=customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty(
            object="object"
        ),
        s3=customerprofiles.CfnIntegration.S3SourcePropertiesProperty(
            bucket_name="bucketName",

            # the properties below are optional
            bucket_prefix="bucketPrefix"
        ),
        salesforce=customerprofiles.CfnIntegration.SalesforceSourcePropertiesProperty(
            object="object",

            # the properties below are optional
            enable_dynamic_field_update=False,
            include_deleted_records=False
        ),
        service_now=customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty(
            object="object"
        ),
        zendesk=customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty(
            object="object"
        )
    ),

    # the properties below are optional
    connector_profile_name="connectorProfileName",
    incremental_pull_config=customerprofiles.CfnIntegration.IncrementalPullConfigProperty(
        datetime_type_field_name="datetimeTypeFieldName"
    )
)

Attributes

connector_profile_name

The name of the Amazon AppFlow connector profile.

This name must be unique for each connector profile in the AWS account .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectorprofilename

connector_type

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectortype

incremental_pull_config

Defines the configuration for a scheduled incremental data pull.

If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-incrementalpullconfig

source_connector_properties

Specifies the information that is required to query a particular source connector.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-sourceconnectorproperties

TaskPropertiesMapProperty

class CfnIntegration.TaskPropertiesMapProperty(*, operator_property_key, property)

Bases: object

A map used to store task-related information.

The execution service looks for particular information based on the TaskType .

Parameters:

  • operator_property_key (str) – The task property key.

  • property (str) – The task property value.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.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_customerprofiles as customerprofiles

task_properties_map_property = customerprofiles.CfnIntegration.TaskPropertiesMapProperty(
    operator_property_key="operatorPropertyKey",
    property="property"
)

Attributes

operator_property_key

The task property key.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-operatorpropertykey

property

The task property value.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-property

TaskProperty

class CfnIntegration.TaskProperty(*, source_fields, task_type, connector_operator=None, destination_field=None, task_properties=None)

Bases: object

The Task property type specifies the class for modeling different type of tasks.

Task implementation varies based on the TaskType.

Parameters:

  • source_fields (Sequence[str]) – The source fields to which a particular task is applied.

  • task_type (str) – Specifies the particular task implementation that Amazon AppFlow performs.

  • connector_operator (Union[IResolvable, ConnectorOperatorProperty, Dict[str, Any], None]) – The operation to be performed on the provided source fields.

  • destination_field (Optional[str]) – A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

  • task_properties (Union[IResolvable, Sequence[Union[IResolvable, TaskPropertiesMapProperty, Dict[str, Any]]], None]) – A map used to store task-related information. The service looks for particular information based on the TaskType.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.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_customerprofiles as customerprofiles

task_property = customerprofiles.CfnIntegration.TaskProperty(
    source_fields=["sourceFields"],
    task_type="taskType",

    # the properties below are optional
    connector_operator=customerprofiles.CfnIntegration.ConnectorOperatorProperty(
        marketo="marketo",
        s3="s3",
        salesforce="salesforce",
        service_now="serviceNow",
        zendesk="zendesk"
    ),
    destination_field="destinationField",
    task_properties=[customerprofiles.CfnIntegration.TaskPropertiesMapProperty(
        operator_property_key="operatorPropertyKey",
        property="property"
    )]
)

Attributes

connector_operator

The operation to be performed on the provided source fields.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-connectoroperator

destination_field

A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-destinationfield

source_fields

The source fields to which a particular task is applied.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-sourcefields

task_properties

A map used to store task-related information.

The service looks for particular information based on the TaskType.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-taskproperties

task_type

Specifies the particular task implementation that Amazon AppFlow performs.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-tasktype

TriggerConfigProperty

class CfnIntegration.TriggerConfigProperty(*, trigger_type, trigger_properties=None)

Bases: object

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Parameters:

  • trigger_type (str) – Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.

  • trigger_properties (Union[IResolvable, TriggerPropertiesProperty, Dict[str, Any], None]) – Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.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_customerprofiles as customerprofiles

trigger_config_property = customerprofiles.CfnIntegration.TriggerConfigProperty(
    trigger_type="triggerType",

    # the properties below are optional
    trigger_properties=customerprofiles.CfnIntegration.TriggerPropertiesProperty(
        scheduled=customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty(
            schedule_expression="scheduleExpression",

            # the properties below are optional
            data_pull_mode="dataPullMode",
            first_execution_from=123,
            schedule_end_time=123,
            schedule_offset=123,
            schedule_start_time=123,
            timezone="timezone"
        )
    )
)

Attributes

trigger_properties

Specifies the configuration details of a schedule-triggered flow that you define.

Currently, these settings only apply to the Scheduled trigger type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggerproperties

trigger_type

Specifies the type of flow trigger.

It can be OnDemand, Scheduled, or Event.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggertype

TriggerPropertiesProperty

class CfnIntegration.TriggerPropertiesProperty(*, scheduled=None)

Bases: object

Specifies the configuration details that control the trigger for a flow.

Currently, these settings only apply to the Scheduled trigger type.

Parameters:

scheduled (Union[IResolvable, ScheduledTriggerPropertiesProperty, Dict[str, Any], None]) – Specifies the configuration details of a schedule-triggered flow that you define.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.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_customerprofiles as customerprofiles

trigger_properties_property = customerprofiles.CfnIntegration.TriggerPropertiesProperty(
    scheduled=customerprofiles.CfnIntegration.ScheduledTriggerPropertiesProperty(
        schedule_expression="scheduleExpression",

        # the properties below are optional
        data_pull_mode="dataPullMode",
        first_execution_from=123,
        schedule_end_time=123,
        schedule_offset=123,
        schedule_start_time=123,
        timezone="timezone"
    )
)

Attributes

scheduled

Specifies the configuration details of a schedule-triggered flow that you define.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html#cfn-customerprofiles-integration-triggerproperties-scheduled

ZendeskSourcePropertiesProperty

class CfnIntegration.ZendeskSourcePropertiesProperty(*, object)

Bases: object

The properties that are applied when using Zendesk as a flow source.

Parameters:

object (str) – The object specified in the Zendesk flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.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_customerprofiles as customerprofiles

zendesk_source_properties_property = customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the Zendesk flow source.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html#cfn-customerprofiles-integration-zendesksourceproperties-object