Class: AWSCDK::Batch::CfnJobDefinition::EvaluateOnExitProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Batch::CfnJobDefinition::EvaluateOnExitProperty

Defined in:

batch/cfn_job_definition.rb

Overview

Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY or EXIT ) if all conditions are met.

If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html

Instance Attribute Summary

• #action ⇒ String readonly

  Specifies the action to take if all of the specified conditions ( onStatusReason , onReason , and onExitCode ) are met.

• #on_exit_code ⇒ String^? readonly

  Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.

• #on_reason ⇒ String^? readonly

  Contains a glob pattern to match against the Reason returned for a job.

• #on_status_reason ⇒ String^? readonly

  Contains a glob pattern to match against the StatusReason returned for a job.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(action:, on_exit_code: nil, on_reason: nil, on_status_reason: nil) ⇒ EvaluateOnExitProperty constructor

  A new instance of EvaluateOnExitProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(action:, on_exit_code: nil, on_reason: nil, on_status_reason: nil) ⇒ EvaluateOnExitProperty

Returns a new instance of EvaluateOnExitProperty.

Parameters:

• action (String) —

  Specifies the action to take if all of the specified conditions ( onStatusReason , onReason , and onExitCode ) are met.

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

  Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.

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

  Contains a glob pattern to match against the Reason returned for a job.

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

  Contains a glob pattern to match against the StatusReason returned for a job.

# File 'batch/cfn_job_definition.rb', line 2043

def initialize(action:, on_exit_code: nil, on_reason: nil, on_status_reason: nil)
  @action = action
  Jsii::Type.check_type(@action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "action")
  @on_exit_code = on_exit_code
  Jsii::Type.check_type(@on_exit_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onExitCode") unless @on_exit_code.nil?
  @on_reason = on_reason
  Jsii::Type.check_type(@on_reason, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onReason") unless @on_reason.nil?
  @on_status_reason = on_status_reason
  Jsii::Type.check_type(@on_status_reason, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "onStatusReason") unless @on_status_reason.nil?
end

Instance Attribute Details

#action ⇒ String (readonly)

Specifies the action to take if all of the specified conditions ( onStatusReason , onReason , and onExitCode ) are met.

The values aren't case sensitive.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-action

# File 'batch/cfn_job_definition.rb', line 2060

def action
  @action
end

#on_exit_code ⇒ String^? (readonly)

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job.

The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onexitcode

# File 'batch/cfn_job_definition.rb', line 2069

def on_exit_code
  @on_exit_code
end

#on_reason ⇒ String^? (readonly)

Contains a glob pattern to match against the Reason returned for a job.

The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onreason

# File 'batch/cfn_job_definition.rb', line 2076

def on_reason
  @on_reason
end

#on_status_reason ⇒ String^? (readonly)

Contains a glob pattern to match against the StatusReason returned for a job.

The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-evaluateonexit.html#cfn-batch-jobdefinition-evaluateonexit-onstatusreason

# File 'batch/cfn_job_definition.rb', line 2083

def on_status_reason
  @on_status_reason
end

Class Method Details

.jsii_properties ⇒ Object

# File 'batch/cfn_job_definition.rb', line 2085

def self.jsii_properties
  {
    :action => "action",
    :on_exit_code => "onExitCode",
    :on_reason => "onReason",
    :on_status_reason => "onStatusReason",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'batch/cfn_job_definition.rb', line 2094

def to_jsii
  result = {}
  result.merge!({
    "action" => @action,
    "onExitCode" => @on_exit_code,
    "onReason" => @on_reason,
    "onStatusReason" => @on_status_reason,
  })
  result.compact
end