Interface CfnExperiment.RunningStatusObjectProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnExperiment.RunningStatusObjectProperty extends
Use this structure to start and stop the experiment.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 RunningStatusObjectProperty runningStatusObjectProperty = RunningStatusObjectProperty.builder()
         // the properties below are optional
  • 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 .

    • 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 .

    • 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.
    • 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.
    • builder

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