CfnIntegrationProps

class aws_cdk.aws_customerprofiles.CfnIntegrationProps(*, domain_name, flow_definition=None, object_type_name, tags=None, uri=None)

Bases: object

Properties for defining a AWS::CustomerProfiles::Integration.

Parameters
  • domain_name (str) – AWS::CustomerProfiles::Integration.DomainName.

  • flow_definition (Union[IResolvable, FlowDefinitionProperty, None]) – AWS::CustomerProfiles::Integration.FlowDefinition.

  • object_type_name (str) – AWS::CustomerProfiles::Integration.ObjectTypeName.

  • tags (Optional[Sequence[CfnTag]]) – AWS::CustomerProfiles::Integration.Tags.

  • uri (Optional[str]) – AWS::CustomerProfiles::Integration.Uri.

Link

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

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_props = customerprofiles.CfnIntegrationProps(
    domain_name="domainName",
    object_type_name="objectTypeName",

    # 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"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    uri="uri"
)

Attributes

domain_name

AWS::CustomerProfiles::Integration.DomainName.

Link

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

Return type

str

flow_definition

AWS::CustomerProfiles::Integration.FlowDefinition.

Link

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

Return type

Union[IResolvable, FlowDefinitionProperty, None]

object_type_name

AWS::CustomerProfiles::Integration.ObjectTypeName.

Link

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

Return type

str

tags

AWS::CustomerProfiles::Integration.Tags.

Link

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

Return type

Optional[List[CfnTag]]

uri

AWS::CustomerProfiles::Integration.Uri.

Link

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

Return type

Optional[str]