CfnIntegration
- class aws_cdk.aws_customerprofiles.CfnIntegration(scope, id, *, domain_name, event_trigger_names=None, flow_definition=None, object_type_name=None, object_type_names=None, tags=None, uri=None)
Bases:
CfnResource
Specifies an Amazon Connect Customer Profiles Integration.
- See:
- CloudformationResource:
AWS::CustomerProfiles::Integration
- 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 import aws_customerprofiles as customerprofiles cfn_integration = customerprofiles.CfnIntegration(self, "MyCfnIntegration", domain_name="domainName", # the properties below are optional event_trigger_names=["eventTriggerNames"], 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" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).domain_name (
str
) – The unique name of the domain.event_trigger_names (
Optional
[Sequence
[str
]]) – A list of unique names for active event triggers associated with the integration.flow_definition (
Union
[IResolvable
,FlowDefinitionProperty
,Dict
[str
,Any
],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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- 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 prefixpath
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 toaddOverride
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 intermediate 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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- 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
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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.
- event_trigger_names
A list of unique names for active event triggers associated with the integration.
- flow_definition
The configuration that controls how Customer Profiles retrieves data from the source.
- 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 tree node.
- object_type_name
The name of the profile object type mapping to use.
- object_type_names
The object type mapping.
- 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
Tag Manager which manages the tags for this resource.
- tags_raw
The tags used to organize, track, or control access for this resource.
- uri
The URI of the S3 bucket or any other type of data source.
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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
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.
- See:
- 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 import 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.
- s3
The operation to be performed on the provided Amazon S3 source fields.
- salesforce
The operation to be performed on the provided Salesforce source fields.
- service_now
The operation to be performed on the provided ServiceNow source fields.
- zendesk
The operation to be performed on the provided Zendesk source fields.
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.
- See:
- 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 import 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.
- flow_name
The specified name of the flow.
Use underscores (_) or hyphens (-) only. Spaces are not allowed.
- kms_arn
The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
- source_flow_config
The configuration that controls how Customer Profiles retrieves data from the source.
- tasks
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
- trigger_config
The trigger settings that determine how and when the flow runs.
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.- See:
- 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 import 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.
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.- See:
- 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 import aws_customerprofiles as customerprofiles marketo_source_properties_property = customerprofiles.CfnIntegration.MarketoSourcePropertiesProperty( object="object" )
Attributes
- object
The object specified in the Marketo flow source.
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.
- See:
- 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 import aws_customerprofiles as customerprofiles object_type_mapping_property = customerprofiles.CfnIntegration.ObjectTypeMappingProperty( key="key", value="value" )
Attributes
- key
The key.
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.
- See:
- 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 import 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.
- bucket_prefix
The object key for the Amazon S3 bucket in which the source files are stored.
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.
- See:
- 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 import 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.
- include_deleted_records
Indicates whether Amazon AppFlow includes deleted files in the flow run.
- object
The object specified in the Salesforce flow source.
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.
- See:
- 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 import 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.
- first_execution_from
Specifies the date range for the records to import from the connector in the first flow run.
- schedule_end_time
Specifies the scheduled end time for a scheduled-trigger flow.
- schedule_expression
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
- schedule_offset
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
- schedule_start_time
Specifies the scheduled start time for a scheduled-trigger flow.
- timezone
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
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.- See:
- 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 import aws_customerprofiles as customerprofiles service_now_source_properties_property = customerprofiles.CfnIntegration.ServiceNowSourcePropertiesProperty( object="object" )
Attributes
- object
The object specified in the ServiceNow flow source.
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:
marketo (
Union
[IResolvable
,MarketoSourcePropertiesProperty
,Dict
[str
,Any
],None
]) – The properties that are applied when Marketo is being used as a source.s3 (
Union
[IResolvable
,S3SourcePropertiesProperty
,Dict
[str
,Any
],None
]) – The properties that are applied when Amazon S3 is being used as the flow source.salesforce (
Union
[IResolvable
,SalesforceSourcePropertiesProperty
,Dict
[str
,Any
],None
]) – The properties that are applied when Salesforce is being used as a source.service_now (
Union
[IResolvable
,ServiceNowSourcePropertiesProperty
,Dict
[str
,Any
],None
]) – The properties that are applied when ServiceNow is being used as a source.zendesk (
Union
[IResolvable
,ZendeskSourcePropertiesProperty
,Dict
[str
,Any
],None
]) – The properties that are applied when using Zendesk as a flow source.
- See:
- 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 import 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.
- s3
The properties that are applied when Amazon S3 is being used as the flow source.
- salesforce
The properties that are applied when Salesforce is being used as a source.
- service_now
The properties that are applied when ServiceNow is being used as a source.
- zendesk
The properties that are applied when using Zendesk as a flow source.
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.
- See:
- 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 import 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 .
- connector_type
The type of connector, such as Salesforce, Marketo, and so on.
- 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.
- source_connector_properties
Specifies the information that is required to query a particular source connector.
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.
- See:
- 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 import 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.
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.
- See:
- 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 import 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.
- destination_field
A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
- source_fields
The source fields to which a particular task is applied.
- task_properties
A map used to store task-related information.
The service looks for particular information based on the TaskType.
- task_type
Specifies the particular task implementation that Amazon AppFlow performs.
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.
- See:
- 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 import 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.
- trigger_type
Specifies the type of flow trigger.
It can be OnDemand, Scheduled, or Event.
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.- See:
- 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 import 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.
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.- See:
- 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 import aws_customerprofiles as customerprofiles zendesk_source_properties_property = customerprofiles.CfnIntegration.ZendeskSourcePropertiesProperty( object="object" )
Attributes
- object
The object specified in the Zendesk flow source.