software.amazon.awscdk.services.evidently

Interface CfnExperiment.RunningStatusObjectProperty

All Known Implementing Classes:

CfnExperiment.RunningStatusObjectProperty.Jsii$Proxy

Enclosing class:

CfnExperiment

public static interface CfnExperiment.RunningStatusObjectProperty

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnExperiment.RunningStatusObjectProperty.Builder	builder()
default java.lang.String	getAnalysisCompleteTime() If you are using AWS CloudFormation to start the experiment, use this field to specify when the experiment is to end.
default java.lang.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 java.lang.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.
java.lang.String	getStatus() To start the experiment now, specify `START` for this parameter.

Method Detail

getStatus

java.lang.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 .

getAnalysisCompleteTime

default java.lang.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 .

getDesiredState

default java.lang.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.

getReason

default java.lang.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.

builder

static CfnExperiment.RunningStatusObjectProperty.Builder builder()

Returns:

a CfnExperiment.RunningStatusObjectProperty.Builder of CfnExperiment.RunningStatusObjectProperty