CfnIntegrationPropsMixin

class aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnIntegrationPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies an Amazon Connect Customer Profiles Integration.

See:

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

CloudformationResource:

AWS::CustomerProfiles::Integration

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

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

cfn_integration_props_mixin = customerprofiles_mixins.CfnIntegrationPropsMixin(customerprofiles_mixins.CfnIntegrationMixinProps(
    domain_name="domainName",
    event_trigger_names=["eventTriggerNames"],
    flow_definition=customerprofiles_mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty(
        description="description",
        flow_name="flowName",
        kms_arn="kmsArn",
        source_flow_config=customerprofiles_mixins.CfnIntegrationPropsMixin.SourceFlowConfigProperty(
            connector_profile_name="connectorProfileName",
            connector_type="connectorType",
            incremental_pull_config=customerprofiles_mixins.CfnIntegrationPropsMixin.IncrementalPullConfigProperty(
                datetime_type_field_name="datetimeTypeFieldName"
            ),
            source_connector_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.SourceConnectorPropertiesProperty(
                marketo=customerprofiles_mixins.CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(
                    object="object"
                ),
                s3=customerprofiles_mixins.CfnIntegrationPropsMixin.S3SourcePropertiesProperty(
                    bucket_name="bucketName",
                    bucket_prefix="bucketPrefix"
                ),
                salesforce=customerprofiles_mixins.CfnIntegrationPropsMixin.SalesforceSourcePropertiesProperty(
                    enable_dynamic_field_update=False,
                    include_deleted_records=False,
                    object="object"
                ),
                service_now=customerprofiles_mixins.CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(
                    object="object"
                ),
                zendesk=customerprofiles_mixins.CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(
                    object="object"
                )
            )
        ),
        tasks=[customerprofiles_mixins.CfnIntegrationPropsMixin.TaskProperty(
            connector_operator=customerprofiles_mixins.CfnIntegrationPropsMixin.ConnectorOperatorProperty(
                marketo="marketo",
                s3="s3",
                salesforce="salesforce",
                service_now="serviceNow",
                zendesk="zendesk"
            ),
            destination_field="destinationField",
            source_fields=["sourceFields"],
            task_properties=[customerprofiles_mixins.CfnIntegrationPropsMixin.TaskPropertiesMapProperty(
                operator_property_key="operatorPropertyKey",
                property="property"
            )],
            task_type="taskType"
        )],
        trigger_config=customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerConfigProperty(
            trigger_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerPropertiesProperty(
                scheduled=customerprofiles_mixins.CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(
                    data_pull_mode="dataPullMode",
                    first_execution_from=123,
                    schedule_end_time=123,
                    schedule_expression="scheduleExpression",
                    schedule_offset=123,
                    schedule_start_time=123,
                    timezone="timezone"
                )
            ),
            trigger_type="triggerType"
        )
    ),
    object_type_name="objectTypeName",
    object_type_names=[customerprofiles_mixins.CfnIntegrationPropsMixin.ObjectTypeMappingProperty(
        key="key",
        value="value"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri="uri"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CustomerProfiles::Integration.

Parameters:

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

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['domainName', 'eventTriggerNames', 'flowDefinition', 'objectTypeName', 'objectTypeNames', 'tags', 'uri']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

Stability:

experimental

ConnectorOperatorProperty

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

connector_operator_property = customerprofiles_mixins.CfnIntegrationPropsMixin.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.

See:

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.

See:

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.

See:

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.

See:

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.

See:

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

FlowDefinitionProperty

class CfnIntegrationPropsMixin.FlowDefinitionProperty(*, description=None, flow_name=None, kms_arn=None, source_flow_config=None, tasks=None, trigger_config=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:

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

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

  • kms_arn (Optional[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], None]) – The configuration that controls how Customer Profiles retrieves data from the source.

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

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

flow_definition_property = customerprofiles_mixins.CfnIntegrationPropsMixin.FlowDefinitionProperty(
    description="description",
    flow_name="flowName",
    kms_arn="kmsArn",
    source_flow_config=customerprofiles_mixins.CfnIntegrationPropsMixin.SourceFlowConfigProperty(
        connector_profile_name="connectorProfileName",
        connector_type="connectorType",
        incremental_pull_config=customerprofiles_mixins.CfnIntegrationPropsMixin.IncrementalPullConfigProperty(
            datetime_type_field_name="datetimeTypeFieldName"
        ),
        source_connector_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.SourceConnectorPropertiesProperty(
            marketo=customerprofiles_mixins.CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(
                object="object"
            ),
            s3=customerprofiles_mixins.CfnIntegrationPropsMixin.S3SourcePropertiesProperty(
                bucket_name="bucketName",
                bucket_prefix="bucketPrefix"
            ),
            salesforce=customerprofiles_mixins.CfnIntegrationPropsMixin.SalesforceSourcePropertiesProperty(
                enable_dynamic_field_update=False,
                include_deleted_records=False,
                object="object"
            ),
            service_now=customerprofiles_mixins.CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(
                object="object"
            ),
            zendesk=customerprofiles_mixins.CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(
                object="object"
            )
        )
    ),
    tasks=[customerprofiles_mixins.CfnIntegrationPropsMixin.TaskProperty(
        connector_operator=customerprofiles_mixins.CfnIntegrationPropsMixin.ConnectorOperatorProperty(
            marketo="marketo",
            s3="s3",
            salesforce="salesforce",
            service_now="serviceNow",
            zendesk="zendesk"
        ),
        destination_field="destinationField",
        source_fields=["sourceFields"],
        task_properties=[customerprofiles_mixins.CfnIntegrationPropsMixin.TaskPropertiesMapProperty(
            operator_property_key="operatorPropertyKey",
            property="property"
        )],
        task_type="taskType"
    )],
    trigger_config=customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerConfigProperty(
        trigger_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerPropertiesProperty(
            scheduled=customerprofiles_mixins.CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(
                data_pull_mode="dataPullMode",
                first_execution_from=123,
                schedule_end_time=123,
                schedule_expression="scheduleExpression",
                schedule_offset=123,
                schedule_start_time=123,
                timezone="timezone"
            )
        ),
        trigger_type="triggerType"
    )
)

Attributes

description

A description of the flow you want to create.

See:

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.

See:

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.

See:

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.

See:

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.

See:

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.

See:

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

IncrementalPullConfigProperty

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

incremental_pull_config_property = customerprofiles_mixins.CfnIntegrationPropsMixin.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.

See:

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

MarketoSourcePropertiesProperty

class CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(*, object=None)

Bases: object

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

Parameters:

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

marketo_source_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the Marketo flow source.

See:

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

ObjectTypeMappingProperty

class CfnIntegrationPropsMixin.ObjectTypeMappingProperty(*, key=None, value=None)

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

  • value (Optional[str]) – The value.

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

object_type_mapping_property = customerprofiles_mixins.CfnIntegrationPropsMixin.ObjectTypeMappingProperty(
    key="key",
    value="value"
)

Attributes

key

The key.

See:

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

value

The value.

See:

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

S3SourcePropertiesProperty

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

Bases: object

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

Parameters:

  • bucket_name (Optional[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.

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

s3_source_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.S3SourcePropertiesProperty(
    bucket_name="bucketName",
    bucket_prefix="bucketPrefix"
)

Attributes

bucket_name

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

See:

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.

See:

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

SalesforceSourcePropertiesProperty

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

Bases: object

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

Parameters:

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

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

salesforce_source_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.SalesforceSourcePropertiesProperty(
    enable_dynamic_field_update=False,
    include_deleted_records=False,
    object="object"
)

Attributes

enable_dynamic_field_update

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

See:

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.

See:

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.

See:

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

ScheduledTriggerPropertiesProperty

class CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(*, data_pull_mode=None, first_execution_from=None, schedule_end_time=None, schedule_expression=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:

  • 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_expression (Optional[str]) – The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

  • 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. The value must be a date/time value in EPOCH format.

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

scheduled_trigger_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(
    data_pull_mode="dataPullMode",
    first_execution_from=123,
    schedule_end_time=123,
    schedule_expression="scheduleExpression",
    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.

See:

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.

See:

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.

See:

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

See:

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.

See:

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.

The value must be a date/time value in EPOCH format.

See:

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.

See:

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

ServiceNowSourcePropertiesProperty

class CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(*, object=None)

Bases: object

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

Parameters:

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

service_now_source_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the ServiceNow flow source.

See:

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

SourceConnectorPropertiesProperty

class CfnIntegrationPropsMixin.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:
See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

source_connector_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.SourceConnectorPropertiesProperty(
    marketo=customerprofiles_mixins.CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(
        object="object"
    ),
    s3=customerprofiles_mixins.CfnIntegrationPropsMixin.S3SourcePropertiesProperty(
        bucket_name="bucketName",
        bucket_prefix="bucketPrefix"
    ),
    salesforce=customerprofiles_mixins.CfnIntegrationPropsMixin.SalesforceSourcePropertiesProperty(
        enable_dynamic_field_update=False,
        include_deleted_records=False,
        object="object"
    ),
    service_now=customerprofiles_mixins.CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(
        object="object"
    ),
    zendesk=customerprofiles_mixins.CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(
        object="object"
    )
)

Attributes

marketo

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

See:

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.

See:

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.

See:

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.

See:

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.

See:

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

SourceFlowConfigProperty

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

Bases: object

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

Parameters:

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

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

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

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

source_flow_config_property = customerprofiles_mixins.CfnIntegrationPropsMixin.SourceFlowConfigProperty(
    connector_profile_name="connectorProfileName",
    connector_type="connectorType",
    incremental_pull_config=customerprofiles_mixins.CfnIntegrationPropsMixin.IncrementalPullConfigProperty(
        datetime_type_field_name="datetimeTypeFieldName"
    ),
    source_connector_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.SourceConnectorPropertiesProperty(
        marketo=customerprofiles_mixins.CfnIntegrationPropsMixin.MarketoSourcePropertiesProperty(
            object="object"
        ),
        s3=customerprofiles_mixins.CfnIntegrationPropsMixin.S3SourcePropertiesProperty(
            bucket_name="bucketName",
            bucket_prefix="bucketPrefix"
        ),
        salesforce=customerprofiles_mixins.CfnIntegrationPropsMixin.SalesforceSourcePropertiesProperty(
            enable_dynamic_field_update=False,
            include_deleted_records=False,
            object="object"
        ),
        service_now=customerprofiles_mixins.CfnIntegrationPropsMixin.ServiceNowSourcePropertiesProperty(
            object="object"
        ),
        zendesk=customerprofiles_mixins.CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(
            object="object"
        )
    )
)

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 .

See:

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.

See:

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.

See:

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.

See:

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

TaskPropertiesMapProperty

class CfnIntegrationPropsMixin.TaskPropertiesMapProperty(*, operator_property_key=None, property=None)

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 (Optional[str]) – The task property key.

  • property (Optional[str]) – The task property value.

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

task_properties_map_property = customerprofiles_mixins.CfnIntegrationPropsMixin.TaskPropertiesMapProperty(
    operator_property_key="operatorPropertyKey",
    property="property"
)

Attributes

operator_property_key

The task property key.

See:

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

property

The task property value.

See:

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

TaskProperty

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

Bases: object

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

Task implementation varies based on the TaskType.

Parameters:

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

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

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

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

task_property = customerprofiles_mixins.CfnIntegrationPropsMixin.TaskProperty(
    connector_operator=customerprofiles_mixins.CfnIntegrationPropsMixin.ConnectorOperatorProperty(
        marketo="marketo",
        s3="s3",
        salesforce="salesforce",
        service_now="serviceNow",
        zendesk="zendesk"
    ),
    destination_field="destinationField",
    source_fields=["sourceFields"],
    task_properties=[customerprofiles_mixins.CfnIntegrationPropsMixin.TaskPropertiesMapProperty(
        operator_property_key="operatorPropertyKey",
        property="property"
    )],
    task_type="taskType"
)

Attributes

connector_operator

The operation to be performed on the provided source fields.

See:

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.

See:

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.

See:

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.

See:

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.

See:

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

TriggerConfigProperty

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

Bases: object

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

Parameters:

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

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

trigger_config_property = customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerConfigProperty(
    trigger_properties=customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerPropertiesProperty(
        scheduled=customerprofiles_mixins.CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(
            data_pull_mode="dataPullMode",
            first_execution_from=123,
            schedule_end_time=123,
            schedule_expression="scheduleExpression",
            schedule_offset=123,
            schedule_start_time=123,
            timezone="timezone"
        )
    ),
    trigger_type="triggerType"
)

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.

See:

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.

See:

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

TriggerPropertiesProperty

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

trigger_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.TriggerPropertiesProperty(
    scheduled=customerprofiles_mixins.CfnIntegrationPropsMixin.ScheduledTriggerPropertiesProperty(
        data_pull_mode="dataPullMode",
        first_execution_from=123,
        schedule_end_time=123,
        schedule_expression="scheduleExpression",
        schedule_offset=123,
        schedule_start_time=123,
        timezone="timezone"
    )
)

Attributes

scheduled

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

See:

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

ZendeskSourcePropertiesProperty

class CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(*, object=None)

Bases: object

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

Parameters:

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

See:

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.
from aws_cdk.mixins_preview.aws_customerprofiles import mixins as customerprofiles_mixins

zendesk_source_properties_property = customerprofiles_mixins.CfnIntegrationPropsMixin.ZendeskSourcePropertiesProperty(
    object="object"
)

Attributes

object

The object specified in the Zendesk flow source.

See:

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