AWS::Evidently::Feature - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Evidently::Feature

Creates or updates an Evidently feature that you want to launch or test. You can define up to five variations of a feature, and use these variations in your launches and experiments. A feature must be created in a project. For information about creating a project, see CreateProject.

Syntax

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

JSON

{
  "Type" : "AWS::Evidently::Feature",
  "Properties" : {
      "DefaultVariation" : String,
      "Description" : String,
      "EntityOverrides" : [ EntityOverride, ... ],
      "EvaluationStrategy" : String,
      "Name" : String,
      "Project" : String,
      "Tags" : [ Tag, ... ],
      "Variations" : [ VariationObject, ... ]
    }
}

YAML

Type: AWS::Evidently::Feature
Properties:
  DefaultVariation: String
  Description: String
  EntityOverrides: 
    - EntityOverride
  EvaluationStrategy: String
  Name: String
  Project: String
  Tags: 
    - Tag
  Variations: 
    - VariationObject

Properties

DefaultVariation

The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

This variation must also be listed in the Variations structure.

If you omit DefaultVariation, the first variation listed in the Variations structure is used as the default variation.

Required: No

Type: String

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

Minimum: 1

Maximum: 127

Update requires: No interruption

Description

An optional description of the feature.

Required: No

Type: String

Minimum: 0

Maximum: 160

Update requires: No interruption

EntityOverrides

Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served.

Required: No

Type: Array of EntityOverride

Minimum: 0

Maximum: 2500

Update requires: No interruption

EvaluationStrategy

Specify ALL_RULES to activate the traffic allocation specified by any ongoing launches or experiments. Specify DEFAULT_VARIATION to serve the default variation to all users instead.

Required: No

Type: String

Allowed values: ALL_RULES | DEFAULT_VARIATION

Update requires: No interruption

Name

The name for the feature. It can include up to 127 characters.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 127

Update requires: Replacement

Project

The name or ARN of the project that is to contain the new feature.

Required: Yes

Type: String

Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)

Minimum: 0

Maximum: 2048

Update requires: Replacement

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 AWS and are interpreted strictly as strings of characters.

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

For more information, see Tagging AWS resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Variations

An array of structures that contain the configuration of the feature's different variations.

Each VariationObject in the Variations array for a feature must have the same type of value (BooleanValue, DoubleValue, LongValue or StringValue).

Required: Yes

Type: Array of VariationObject

Minimum: 1

Maximum: 5

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 feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature

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 ARN of the feature. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/feature/myFeature.