AWS::Evidently::Segment - Amazon CloudFormation
SyntaxPropertiesReturn values
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::Evidently::Segment

Creates or updates a segment of your audience. A segment is a portion of your audience that share one or more characteristics. Examples could be Chrome browser users, users in Europe, or Firefox browser users in Europe who also fit other criteria that your application collects, such as age.

Using a segment in an experiment limits that experiment to evaluate only the users who match the segment criteria. Using one or more segments in a launch allow you to define different traffic splits for the different audience segments.

For more information about segment pattern syntax, see Segment rule pattern syntax.

The pattern that you define for a segment is matched against the value of evaluationContext, which is passed into Evidently in the EvaluateFeature operation, when Evidently assigns a feature variation to a user.

Syntax

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

JSON

{
  "Type" : "AWS::Evidently::Segment",
  "Properties" : {
      "Description" : String,
      "Name" : String,
      "Pattern" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Evidently::Segment
Properties:
  Description: String
  Name: String
  Pattern: String
  Tags: 
    - Tag

Properties

Description

An optional description for this segment.

Required: No

Type: String

Minimum: 0

Maximum: 160

Update requires: No interruption

Name

A name for the segment.

Required: Yes

Type: String

Pattern: [-a-zA-Z0-9._]*

Minimum: 1

Maximum: 127

Update requires: No interruption

Pattern

The pattern to use for the segment. For more information about pattern syntax, see Segment rule pattern syntax.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Tags

Assigns one or more tags (key-value pairs) to the feature.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with a feature.

For more information, see Tagging Amazon resources.

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 ARN of the segment. For example, arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment

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 ARN of the segment. For example, arn:aws:evidently:us-west-2:123456789012:segment/australiaSegment