aws-cdk-lib.aws_evidently.CfnExperiment.RunningStatusObjectProperty

RunningStatusObjectProperty Struct

Use this structure to start and stop the experiment.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_evidently as evidently } from 'aws-cdk-lib';
const runningStatusObjectProperty: evidently.CfnExperiment.RunningStatusObjectProperty = {
  status: 'status',

  // the properties below are optional
  analysisCompleteTime: 'analysisCompleteTime',
  desiredState: 'desiredState',
  reason: 'reason',
};

Properties

analysisCompleteTimestringanalysis_complete_timestranalysisCompleteTimeStringAnalysisCompleteTimestringAnalysisCompleteTime*string#

If you are using CloudFormation to start the experiment, use this field to specify when the experiment is to end.

The format is as a UNIX timestamp. For more information about this format, see The Current Epoch Unix Timestamp .

desiredStatestringdesired_statestrdesiredStateStringDesiredStatestringDesiredState*string#

If you are using CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment.

reasonstringreasonstrreasonStringReasonstringReason*string#

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

statusstringstatusstrstatusStringStatusstringStatus*stringrequired#

To start the experiment now, specify `START` for this parameter.

If this experiment is currently running and you want to stop it now, specify STOP .