AWS::Evidently::Launch ExecutionStatusObject - Amazon CloudFormation
SyntaxProperties
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).

AWS::Evidently::Launch ExecutionStatusObject

Use this structure to start and stop the launch.

Syntax

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

JSON

{
  "DesiredState" : String,
  "Reason" : String,
  "Status" : String
}

YAML

  DesiredState: String
  Reason: String
  Status: String

Properties

DesiredState

If you are using Amazon CloudFormation to stop this launch, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment. If you omit this parameter, the default of COMPLETED is used.

Required: No

Type: String

Update requires: No interruption

Reason

If you are using Amazon CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled.

Required: No

Type: String

Update requires: No interruption

Status

To start the launch now, specify START for this parameter. If this launch is currently running and you want to stop it now, specify STOP.

Required: Yes

Type: String

Update requires: No interruption