Class: AWSCDK::Evidently::CfnExperiment::RunningStatusObjectProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
evidently/cfn_experiment.rb

Overview

Use this structure to start and stop the experiment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, analysis_complete_time: nil, desired_state: nil, reason: nil) ⇒ RunningStatusObjectProperty

Returns a new instance of RunningStatusObjectProperty.

Parameters:

  • status (String) —

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

  • analysis_complete_time (String, nil) (defaults to: nil) —

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

  • desired_state (String, nil) (defaults to: nil) —

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

  • reason (String, nil) (defaults to: nil) —

    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.



809
810
811
812
813
814
815
816
817
818
 
# File 'evidently/cfn_experiment.rb', line 809

def initialize(status:, analysis_complete_time: nil, desired_state: nil, reason: nil)
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @analysis_complete_time = analysis_complete_time
  Jsii::Type.check_type(@analysis_complete_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "analysisCompleteTime") unless @analysis_complete_time.nil?
  @desired_state = desired_state
  Jsii::Type.check_type(@desired_state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "desiredState") unless @desired_state.nil?
  @reason = reason
  Jsii::Type.check_type(@reason, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reason") unless @reason.nil?
end

Instance Attribute Details

#analysis_complete_time ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



833
834
835
 
# File 'evidently/cfn_experiment.rb', line 833

def analysis_complete_time
  @analysis_complete_time
end

#desired_state ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



838
839
840
 
# File 'evidently/cfn_experiment.rb', line 838

def desired_state
  @desired_state
end

#reason ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



843
844
845
 
# File 'evidently/cfn_experiment.rb', line 843

def reason
  @reason
end

#status ⇒ String (readonly)

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 .

Returns:

  • (String)

See Also:



826
827
828
 
# File 'evidently/cfn_experiment.rb', line 826

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



845
846
847
848
849
850
851
852
 
# File 'evidently/cfn_experiment.rb', line 845

def self.jsii_properties
  {
    :status => "status",
    :analysis_complete_time => "analysisCompleteTime",
    :desired_state => "desiredState",
    :reason => "reason",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



854
855
856
857
858
859
860
861
862
863
 
# File 'evidently/cfn_experiment.rb', line 854

def to_jsii
  result = {}
  result.merge!({
    "status" => @status,
    "analysisCompleteTime" => @analysis_complete_time,
    "desiredState" => @desired_state,
    "reason" => @reason,
  })
  result.compact
end