AWS::CustomerProfiles::SegmentDefinition

CustomerProfiles SegmentDefinition

A segment definition resource of Amazon Connect Customer Profiles

Properties

7 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`DisplayName`	`string`	RequiredCreate-only
`DomainName`	`string`	RequiredCreate-only
`SegmentDefinitionName`	`string`	RequiredCreate-only
`Description`	`string`
`SegmentGroups`	`SegmentGroup`	Create-only
`SegmentSqlQuery`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	The time of this segment definition got created.
`SegmentDefinitionArn`	`string`	The Amazon Resource Name (ARN) of the segment definition.
`SegmentType`	`string`	The SQL query that defines the segment criteria.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CustomerProfiles::SegmentDefinition

Resources:
  MyResource:
    Type: AWS::CustomerProfiles::SegmentDefinition
    Properties:
      DomainName: "my-domainname"
      DisplayName: "my-displayname"
      SegmentDefinitionName: "my-segmentdefinitionname"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

profile:CreateSegmentDefinitionprofile:TagResourcekms:CreateGrantkms:DescribeKeykms:GetKeyPolicykms:PutKeyPolicykms:ListGrantskms:GenerateDataKey

read

profile:GetSegmentDefinitionkms:CreateGrantkms:DescribeKeykms:GetKeyPolicykms:PutKeyPolicykms:ListGrantskms:GenerateDataKey

update

profile:GetSegmentDefinitionprofile:UntagResourceprofile:TagResourcekms:CreateGrantkms:DescribeKeykms:GetKeyPolicykms:PutKeyPolicykms:ListGrants

delete

profile:DeleteSegmentDefinitionkms:CreateGrantkms:DescribeKeykms:GetKeyPolicykms:PutKeyPolicykms:ListGrantskms:GenerateDataKey

list

profile:ListSegmentDefinitionskms:CreateGrantkms:DescribeKeykms:GetKeyPolicykms:PutKeyPolicykms:ListGrantskms:GenerateDataKey

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCustomerProfiles

Properties10

Required3

TaggingSupported

Primary IDDomainName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainNameSegmentDefinitionNameDisplayNameSegmentGroupsSegmentSqlQuery

Related Resources

External Links

AWS Documentation