Class: AWSCDK::Batch::CfnComputeEnvironment::UpdatePolicyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Batch::CfnComputeEnvironment::UpdatePolicyProperty

Defined in:

batch/cfn_compute_environment.rb

Overview

Specifies the infrastructure update policy for the Amazon EC2 compute environment.

For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .

See Also:

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

Instance Attribute Summary

• #job_execution_timeout_minutes ⇒ Numeric^? readonly

  Specifies the job timeout (in minutes) when the compute environment infrastructure is updated.

• #terminate_jobs_on_update ⇒ Boolean, ... readonly

  Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(job_execution_timeout_minutes: nil, terminate_jobs_on_update: nil) ⇒ UpdatePolicyProperty constructor

  A new instance of UpdatePolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(job_execution_timeout_minutes: nil, terminate_jobs_on_update: nil) ⇒ UpdatePolicyProperty

Returns a new instance of UpdatePolicyProperty.

Parameters:

• job_execution_timeout_minutes (Numeric, nil) (defaults to: nil) —

  Specifies the job timeout (in minutes) when the compute environment infrastructure is updated.

• terminate_jobs_on_update (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated.

# File 'batch/cfn_compute_environment.rb', line 1393

def initialize(job_execution_timeout_minutes: nil, terminate_jobs_on_update: nil)
  @job_execution_timeout_minutes = job_execution_timeout_minutes
  Jsii::Type.check_type(@job_execution_timeout_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "jobExecutionTimeoutMinutes") unless @job_execution_timeout_minutes.nil?
  @terminate_jobs_on_update = terminate_jobs_on_update
  Jsii::Type.check_type(@terminate_jobs_on_update, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "terminateJobsOnUpdate") unless @terminate_jobs_on_update.nil?
end

Instance Attribute Details

#job_execution_timeout_minutes ⇒ Numeric^? (readonly)

Note:

Default: - 30

Specifies the job timeout (in minutes) when the compute environment infrastructure is updated.

The default value is 30.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-updatepolicy.html#cfn-batch-computeenvironment-updatepolicy-jobexecutiontimeoutminutes

# File 'batch/cfn_compute_environment.rb', line 1407

def job_execution_timeout_minutes
  @job_execution_timeout_minutes
end

#terminate_jobs_on_update ⇒ Boolean, ... (readonly)

Note:

Default: - false

Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated.

The default value is false .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-updatepolicy.html#cfn-batch-computeenvironment-updatepolicy-terminatejobsonupdate

# File 'batch/cfn_compute_environment.rb', line 1415

def terminate_jobs_on_update
  @terminate_jobs_on_update
end

Class Method Details

.jsii_properties ⇒ Object

# File 'batch/cfn_compute_environment.rb', line 1417

def self.jsii_properties
  {
    :job_execution_timeout_minutes => "jobExecutionTimeoutMinutes",
    :terminate_jobs_on_update => "terminateJobsOnUpdate",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'batch/cfn_compute_environment.rb', line 1424

def to_jsii
  result = {}
  result.merge!({
    "jobExecutionTimeoutMinutes" => @job_execution_timeout_minutes,
    "terminateJobsOnUpdate" => @terminate_jobs_on_update,
  })
  result.compact
end