AWS CloudFormation
User Guide (Version )

AWS::Pinpoint::Segment

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Syntax

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

JSON

{ "Type" : "AWS::Pinpoint::Segment", "Properties" : { "ApplicationId" : String, "Dimensions" : SegmentDimensions, "Name" : String, "SegmentGroups" : SegmentGroups, "Tags" : Json } }

YAML

Type: AWS::Pinpoint::Segment Properties: ApplicationId: String Dimensions: SegmentDimensions Name: String SegmentGroups: SegmentGroups Tags: Json

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

Required: Yes

Type: String

Update requires: Replacement

Dimensions

The criteria that define the dimensions for the segment.

Required: No

Type: SegmentDimensions

Update requires: No interruption

Name

The name of the segment.

Required: Yes

Type: String

Update requires: No interruption

SegmentGroups

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

Required: No

Type: SegmentGroups

Update requires: No interruption

Tags

A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

Required: No

Type: Json

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier (ApplicationId) for the Amazon Pinpoint application that the segment is associated with.

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.

Arn

The Amazon Resource Name (ARN) of the segment.

SegmentId

The unique identifier for the segment.