AWS::CustomerProfiles::Integration - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CustomerProfiles::Integration

Specifies an Amazon Connect Customer Profiles Integration.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CustomerProfiles::Integration",
  "Properties" : {
      "DomainName" : String,
      "EventTriggerNames" : [ String, ... ],
      "FlowDefinition" : FlowDefinition,
      "ObjectTypeName" : String,
      "ObjectTypeNames" : [ ObjectTypeMapping, ... ],
      "Tags" : [ Tag, ... ],
      "Uri" : String
    }
}

YAML

Type: AWS::CustomerProfiles::Integration
Properties:
  DomainName: String
  EventTriggerNames: 
    - String
  FlowDefinition: 
    FlowDefinition
  ObjectTypeName: String
  ObjectTypeNames: 
    - ObjectTypeMapping
  Tags: 
    - Tag
  Uri: String

Properties

DomainName

The unique name of the domain.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

EventTriggerNames

A list of unique names for active event triggers associated with the integration.

Required: No

Type: Array of String

Minimum: 1 | 1

Maximum: 64 | 1

Update requires: No interruption

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

Pattern: ^[a-zA-Z_][a-zA-Z_0-9-]*$

Minimum: 1

Maximum: 255

Update requires: No interruption

ObjectTypeNames

The object type mapping.

Required: No

Type: Array of ObjectTypeMapping

Update requires: No interruption

Tags

The tags used to organize, track, or control access for this resource.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Uri

The URI of the S3 bucket or any other type of data source.

Required: No

Type: String

Minimum: 1

Maximum: 255

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.

CreatedAt

The timestamp of when the integration was created.

LastUpdatedAt

The timestamp of when the integration was most recently edited.

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" } } }
}