CfnIntegrationProps Struct
Properties for defining a CfnIntegration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const cfnIntegrationProps: customerprofiles.CfnIntegrationProps = {
domainName: 'domainName',
// the properties below are optional
eventTriggerNames: ['eventTriggerNames'],
flowDefinition: {
flowName: 'flowName',
kmsArn: 'kmsArn',
sourceFlowConfig: {
connectorType: 'connectorType',
sourceConnectorProperties: {
marketo: {
object: 'object',
},
s3: {
bucketName: 'bucketName',
// the properties below are optional
bucketPrefix: 'bucketPrefix',
},
salesforce: {
object: 'object',
// the properties below are optional
enableDynamicFieldUpdate: false,
includeDeletedRecords: false,
},
serviceNow: {
object: 'object',
},
zendesk: {
object: 'object',
},
},
// the properties below are optional
connectorProfileName: 'connectorProfileName',
incrementalPullConfig: {
datetimeTypeFieldName: 'datetimeTypeFieldName',
},
},
tasks: [{
sourceFields: ['sourceFields'],
taskType: 'taskType',
// the properties below are optional
connectorOperator: {
marketo: 'marketo',
s3: 's3',
salesforce: 'salesforce',
serviceNow: 'serviceNow',
zendesk: 'zendesk',
},
destinationField: 'destinationField',
taskProperties: [{
operatorPropertyKey: 'operatorPropertyKey',
property: 'property',
}],
}],
triggerConfig: {
triggerType: 'triggerType',
// the properties below are optional
triggerProperties: {
scheduled: {
scheduleExpression: 'scheduleExpression',
// the properties below are optional
dataPullMode: 'dataPullMode',
firstExecutionFrom: 123,
scheduleEndTime: 123,
scheduleOffset: 123,
scheduleStartTime: 123,
timezone: 'timezone',
},
},
},
// the properties below are optional
description: 'description',
},
objectTypeName: 'objectTypeName',
objectTypeNames: [{
key: 'key',
value: 'value',
}],
scope: 'scope',
tags: [{
key: 'key',
value: 'value',
}],
uri: 'uri',
};
Properties
The unique name of the domain.
eventTriggerNamesoptionalstring[]event_trigger_namesoptionaltyping.List[str]eventTriggerNamesoptionalList<String>EventTriggerNamesoptionalstring[]EventTriggerNamesoptional*[]*string#A list of unique names for active event triggers associated with the integration.
flowDefinitionoptionalIResolvable | CfnIntegration.FlowDefinitionPropertyflow_definitionoptionaltyping.Union[IResolvable, FlowDefinitionProperty]flowDefinitionoptionalIResolvableFlowDefinitionoptionalIResolvableFlowDefinitionoptionalinterface{}#The configuration that controls how Customer Profiles retrieves data from the source.
objectTypeNameoptionalstringobject_type_nameoptionalstrobjectTypeNameoptionalStringObjectTypeNameoptionalstringObjectTypeNameoptional*string#The name of the profile object type mapping to use.
objectTypeNamesoptionalIResolvable | IResolvable | CfnIntegration.ObjectTypeMappingProperty[]object_type_namesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ObjectTypeMappingProperty]]]objectTypeNamesoptionalIResolvableObjectTypeNamesoptionalIResolvableObjectTypeNamesoptionalinterface{}#The object type mapping.
Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#The tags used to organize, track, or control access for this resource.
The URI of the S3 bucket or any other type of data source.