AWS::Pinpoint::Segment - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Pinpoint::Segment

Updates the configuration, dimension, and other settings for an existing segment.

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" : [ Tag, ... ]
    }
}

YAML

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

Properties

ApplicationId

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

Required: Yes

Type: String

Update requires: Replacement

Dimensions

An array that defines the dimensions for the segment.

Required: No

Type: SegmentDimensions

Update requires: No interruption

Name

The name of the segment.

Note

A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.

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

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

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.