AWS::Evidently::Launch

Creates or updates a launch of a given feature. Before you create a launch, you must create the feature to use for the launch.

You can use a launch to safely validate new features by serving them to a specified percentage of your users while you roll out the feature. You can monitor the performance of the new feature to help you decide when to ramp up traffic to more users. This helps you reduce risk and identify unintended consequences before you fully launch the feature.

Syntax

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

JSON

{
  "Type" : "AWS::Evidently::Launch",
  "Properties" : {
      "Description" : String,
      "ExecutionStatus" : ExecutionStatusObject,
      "Groups" : [ LaunchGroupObject, ... ],
      "MetricMonitors" : [ MetricDefinitionObject, ... ],
      "Name" : String,
      "Project" : String,
      "RandomizationSalt" : String,
      "ScheduledSplitsConfig" : [ StepConfig, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Evidently::Launch
Properties: 
  Description: String
  ExecutionStatus: 
    ExecutionStatusObject
  Groups: 
    - LaunchGroupObject
  MetricMonitors: 
    - MetricDefinitionObject
  Name: String
  Project: String
  RandomizationSalt: String
  ScheduledSplitsConfig: 
    - StepConfig
  Tags: 
    - Tag

Properties

Description

An optional description for the launch.

Required: No

Type: String

Update requires: No interruption

ExecutionStatus

A structure that you can use to start and stop the launch.

Required: No

Type: ExecutionStatusObject

Update requires: No interruption

Groups

An array of structures that contains the feature and variations that are to be used for the launch. You can up to five launch groups in a launch.

Required: Yes

Type: List of LaunchGroupObject

Update requires: No interruption

MetricMonitors

An array of structures that define the metrics that will be used to monitor the launch performance. You can have up to three metric monitors in the array.

Required: No

Type: List of MetricDefinitionObject

Update requires: No interruption

Name

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

Required: Yes

Type: String

Update requires: Replacement

Project

The name or ARN of the project that you want to create the launch in.

Required: Yes

Type: String

Update requires: Replacement

RandomizationSalt

When Evidently assigns a particular user session to a launch, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the launch name as the randomizationsSalt.

Required: No

Type: String

Update requires: No interruption

ScheduledSplitsConfig

An array of structures that define the traffic allocation percentages among the feature variations during each step of the launch.

Required: Yes

Type: List of StepConfig

Update requires: No interruption

Tags

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

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 launch.

For more information, see Tagging AWS resources.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

The ARN of the launch. For example, arn:aws:evidently:us-west-2:0123455678912:project/myProject/launch/myLaunch