Package software.amazon.awscdk.services.evidently

Interface CfnExperiment.RunningStatusObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExperiment.RunningStatusObjectProperty.Jsii$Proxy

Enclosing class:

CfnExperiment

@Stability(Stable)
public static interface CfnExperiment.RunningStatusObjectProperty
extends software.amazon.jsii.JsiiSerializable

Use this structure to start and stop the experiment.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExperiment.RunningStatusObjectProperty.Builder	A builder for CfnExperiment.RunningStatusObjectProperty
static final class	CfnExperiment.RunningStatusObjectProperty.Jsii$Proxy	An implementation for CfnExperiment.RunningStatusObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnExperiment.RunningStatusObjectProperty.Builder	builder()
default String	getAnalysisCompleteTime()	If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end.
default String	getDesiredState()	If you are using AWS CloudFormation to stop this experiment, specify either COMPLETED or CANCELLED here to indicate how to classify this experiment.
default String	getReason()	If you are using AWS CloudFormation to stop this experiment, this is an optional field that you can use to record why the experiment is being stopped or cancelled.
String	getStatus()	To start the experiment now, specify START for this parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatus

@Stability(Stable)
@NotNull
String getStatus()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-status

getAnalysisCompleteTime

@Stability(Stable)
@Nullable
default String getAnalysisCompleteTime()

If you are using AWS 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-analysiscompletetime

getDesiredState

@Stability(Stable)
@Nullable
default String getDesiredState()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-desiredstate

getReason

@Stability(Stable)
@Nullable
default String getReason()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-runningstatusobject.html#cfn-evidently-experiment-runningstatusobject-reason

builder

@Stability(Stable)
static CfnExperiment.RunningStatusObjectProperty.Builder builder()

Returns:

a CfnExperiment.RunningStatusObjectProperty.Builder of CfnExperiment.RunningStatusObjectProperty