AWS::CustomerProfiles::Integration
Specifies an Amazon Connect Customer Profiles Integration.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::CustomerProfiles::Integration", "Properties" : { "DomainName" :
String
, "FlowDefinition" :FlowDefinition
, "ObjectTypeName" :String
, "ObjectTypeNames" :[ ObjectTypeMapping, ... ]
, "Tags" :[ Tag, ... ]
, "Uri" :String
} }
YAML
Type: AWS::CustomerProfiles::Integration Properties: DomainName:
String
FlowDefinition:FlowDefinition
ObjectTypeName:String
ObjectTypeNames:- ObjectTypeMapping
Tags:- Tag
Uri:String
Properties
DomainName
-
The unique name of the domain.
Required: Yes
Type: String
Update requires: Replacement
FlowDefinition
-
The configuration that controls how Customer Profiles retrieves data from the source.
Required: No
Type: FlowDefinition
Update requires: No interruption
ObjectTypeName
-
The name of the profile object type mapping to use.
Required: No
Type: String
Update requires: No interruption
ObjectTypeNames
-
The object type mapping.
Required: No
Type: List of ObjectTypeMapping
Update requires: No interruption
Tags
-
The tags used to organize, track, or control access for this resource.
Required: No
Type: List of Tag
Update requires: No interruption
Uri
-
The URI of the S3 bucket or any other type of data source.
Required: No
Type: String
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the DomainName and the Uri of the integration.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
Examples
The following example creates an integration if Domain existed.
YAML
Type: "AWS::CustomerProfiles::Integration" Properties: DomainName: "ExampleDomain" ObjectTypeName: "CTR" Uri: "arn:aws:connect:us-east-1:123456789012:instance/11111111-1111-1111-1111-111111111111"
JSON
"Type": "AWS::CustomerProfiles::Integration", "Properties": { "DomainName": "ExampleDomain", "ObjectTypeName": "CTR", "Uri": "arn:aws:connect:us-east-1:123456789012:instance/11111111-1111-1111-1111-111111111111" } } } }