interface ExecutionStatusObjectProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Evidently.CfnLaunch.ExecutionStatusObjectProperty |
Java | software.amazon.awscdk.services.evidently.CfnLaunch.ExecutionStatusObjectProperty |
Python | aws_cdk.aws_evidently.CfnLaunch.ExecutionStatusObjectProperty |
TypeScript | @aws-cdk/aws-evidently » CfnLaunch » ExecutionStatusObjectProperty |
Use this structure to start and stop the launch.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as evidently from '@aws-cdk/aws-evidently';
const executionStatusObjectProperty: evidently.CfnLaunch.ExecutionStatusObjectProperty = {
status: 'status',
// the properties below are optional
desiredState: 'desiredState',
reason: 'reason',
};
Properties
Name | Type | Description |
---|---|---|
status | string | To start the launch now, specify START for this parameter. |
desired | string | If you are using AWS CloudFormation to stop this launch, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment. |
reason? | string | If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled. |
status
Type:
string
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
.
desiredState?
Type:
string
(optional)
If you are using AWS 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.
reason?
Type:
string
(optional)
If you are using AWS CloudFormation to stop this launch, this is an optional field that you can use to record why the launch is being stopped or cancelled.