Class: AWSCDK::Evidently::CfnLaunch::ExecutionStatusObjectProperty

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

Overview

Use this structure to start and stop the launch.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, desired_state: nil, reason: nil) ⇒ ExecutionStatusObjectProperty

Returns a new instance of ExecutionStatusObjectProperty.

Parameters:

  • status (String) —

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

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

    If you are using CloudFormation to stop this launch, 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 launch, this is an optional field that you can use to record why the launch is being stopped or cancelled.



630
631
632
633
634
635
636
637
 
# File 'evidently/cfn_launch.rb', line 630

def initialize(status:, desired_state: nil, reason: nil)
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status")
  @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

#desired_state ⇒ String? (readonly)

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

If you omit this parameter, the default of COMPLETED is used.

Returns:

  • (String, nil)

See Also:



652
653
654
 
# File 'evidently/cfn_launch.rb', line 652

def desired_state
  @desired_state
end

#reason ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



657
658
659
 
# File 'evidently/cfn_launch.rb', line 657

def reason
  @reason
end

#status ⇒ String (readonly)

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

If this launch is currently running and you want to stop it now, specify STOP .

Returns:

  • (String)

See Also:



645
646
647
 
# File 'evidently/cfn_launch.rb', line 645

def status
  @status
end

Class Method Details

.jsii_properties ⇒ Object 



659
660
661
662
663
664
665
 
# File 'evidently/cfn_launch.rb', line 659

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

Instance Method Details

#to_jsii ⇒ Object 



667
668
669
670
671
672
673
674
675
 
# File 'evidently/cfn_launch.rb', line 667

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