AWS::CustomerProfiles::SegmentDefinition - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::CustomerProfiles::SegmentDefinition

A segment definition resource of Amazon Connect Customer Profiles.

Syntax

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

JSON

{
  "Type" : "AWS::CustomerProfiles::SegmentDefinition",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "DomainName" : String,
      "SegmentDefinitionName" : String,
      "SegmentGroups" : SegmentGroup,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CustomerProfiles::SegmentDefinition
Properties:
  Description: String
  DisplayName: String
  DomainName: String
  SegmentDefinitionName: String
  SegmentGroups: 
    SegmentGroup
  Tags: 
    - Tag

Properties

Description

The description of the segment definition.

Required: No

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

DisplayName

Display name of the segment definition.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

DomainName

The name of the domain.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

SegmentDefinitionName

Name of the segment definition.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 64

Update requires: Replacement

SegmentGroups

Contains all groups of the segment definition.

Required: Yes

Type: SegmentGroup

Update requires: Replacement

Tags

The tags belonging to the segment definition.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreatedAt

When the segment definition was created.

SegmentDefinitionArn

The arn of the segment definition.