Skip to content
v2.277.0

RunningStatusObjectProperty Struct ​

Use this structure to start and stop the experiment.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_evidently as evidently

running_status_object_property = evidently.CfnExperiment.RunningStatusObjectProperty(
    status="status",

    # the properties below are optional
    analysis_complete_time="analysisCompleteTime",
    desired_state="desiredState",
    reason="reason"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.evidently.*;

RunningStatusObjectProperty runningStatusObjectProperty = RunningStatusObjectProperty.builder()
        .status("status")

        // the properties below are optional
        .analysisCompleteTime("analysisCompleteTime")
        .desiredState("desiredState")
        .reason("reason")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Evidently;

var runningStatusObjectProperty = new RunningStatusObjectProperty {
    Status = "status",

    // the properties below are optional
    AnalysisCompleteTime = "analysisCompleteTime",
    DesiredState = "desiredState",
    Reason = "reason"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

runningStatusObjectProperty := &RunningStatusObjectProperty{
	Status: jsii.String("status"),

	// the properties below are optional
	AnalysisCompleteTime: jsii.String("analysisCompleteTime"),
	DesiredState: jsii.String("desiredState"),
	Reason: jsii.String("reason"),
}

Properties ​

analysisCompleteTimeoptionalstringanalysis_complete_timeoptionalstranalysisCompleteTimeoptionalStringAnalysisCompleteTimeoptionalstringAnalysisCompleteTimeoptional*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 .

desiredStateoptionalstringdesired_stateoptionalstrdesiredStateoptionalStringDesiredStateoptionalstringDesiredStateoptional*string#
If you are using CloudFormation to stop this experiment, specify either `COMPLETED` or `CANCELLED` here to indicate how to classify this experiment.
reasonoptionalstringreasonoptionalstrreasonoptionalStringReasonoptionalstringReasonoptional*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 .