Class: Aws::Batch::Types::JobDefinition

Inherits:

Struct

Object
Struct
Aws::Batch::Types::JobDefinition

show all

Includes:: Structure

Defined in:: lib/aws-sdk-batch/types.rb

Overview

An object that represents an Batch job definition.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#container_orchestration_type ⇒ String

The orchestration type of the compute environment.
#container_properties ⇒ Types::ContainerProperties

An object with properties specific to Amazon ECS-based jobs.
#ecs_properties ⇒ Types::EcsProperties

An object that contains the properties for the Amazon ECS resources of a job.When ‘ecsProperties` is used in the job definition, it can’t be used in addition to ‘containerProperties`, `eksProperties`, or `nodeProperties`.
#eks_properties ⇒ Types::EksProperties

An object with properties that are specific to Amazon EKS-based jobs.
#job_definition_arn ⇒ String

The Amazon Resource Name (ARN) for the job definition.
#job_definition_name ⇒ String

The name of the job definition.
#node_properties ⇒ Types::NodeProperties

An object with properties that are specific to multi-node parallel jobs.
#parameters ⇒ Hash<String,String>

Default parameters or parameter substitution placeholders that are set in the job definition.
#platform_capabilities ⇒ Array<String>

The platform capabilities required by the job definition.
#propagate_tags ⇒ Boolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
#retry_strategy ⇒ Types::RetryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition.
#revision ⇒ Integer

The revision of the job definition.
#scheduling_priority ⇒ Integer

The scheduling priority of the job definition.
#status ⇒ String

The status of the job definition.
#tags ⇒ Hash<String,String>

The tags that are applied to the job definition.
#timeout ⇒ Types::JobTimeout

The timeout time for jobs that are submitted with this job definition.
#type ⇒ String

The type of job definition.

Instance Attribute Details

#container_orchestration_type ⇒ `String`

The orchestration type of the compute environment. The valid values are ‘ECS` (default) or `EKS`.

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#container_properties ⇒ `Types::ContainerProperties`

An object with properties specific to Amazon ECS-based jobs. When ‘containerProperties` is used in the job definition, it can’t be used in addition to ‘eksProperties`, `ecsProperties`, or `nodeProperties`.

Returns:

(Types::ContainerProperties)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#ecs_properties ⇒ `Types::EcsProperties`

An object that contains the properties for the Amazon ECS resources of a job.When ‘ecsProperties` is used in the job definition, it can’t be used in addition to ‘containerProperties`, `eksProperties`, or `nodeProperties`.

Returns:

(Types::EcsProperties)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#eks_properties ⇒ `Types::EksProperties`

An object with properties that are specific to Amazon EKS-based jobs. When ‘eksProperties` is used in the job definition, it can’t be used in addition to ‘containerProperties`, `ecsProperties`, or `nodeProperties`.

Returns:

(Types::EksProperties)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#job_definition_arn ⇒ `String`

The Amazon Resource Name (ARN) for the job definition.

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#job_definition_name ⇒ `String`

The name of the job definition.

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#node_properties ⇒ `Types::NodeProperties`

An object with properties that are specific to multi-node parallel jobs. When ‘nodeProperties` is used in the job definition, it can’t be used in addition to ‘containerProperties`, `ecsProperties`, or `eksProperties`.

<note markdown=“1”> If the job runs on Fargate resources, don’t specify ‘nodeProperties`. Use `containerProperties` instead.

</note>

Returns:

(Types::NodeProperties)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ `Hash<String,String>`

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a ‘SubmitJob` request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see [Job definition parameters] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#platform_capabilities ⇒ `Array<String>`

The platform capabilities required by the job definition. If no value is specified, it defaults to ‘EC2`. Jobs run on Fargate resources specify `FARGATE`.

Returns:

(Array<String>)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tags ⇒ `Boolean`

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren’t propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the ‘FAILED` state.

Returns:

(Boolean)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#retry_strategy ⇒ `Types::RetryStrategy`

The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:

(Types::RetryStrategy)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#revision ⇒ `Integer`

The revision of the job definition.

Returns:

(Integer)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_priority ⇒ `Integer`

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Returns:

(Integer)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the job definition.

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The tags that are applied to the job definition.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ `Types::JobTimeout`

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren’t finished.

Returns:

(Types::JobTimeout)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ `String`

The type of job definition. It’s either ‘container` or `multinode`. If the job is run on Fargate resources, then `multinode` isn’t supported. For more information about multi-node parallel jobs, see

Creating a multi-node parallel job definition][1: in the *Batch

User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 4869

class JobDefinition < Struct.new(
  :job_definition_name,
  :job_definition_arn,
  :revision,
  :status,
  :type,
  :scheduling_priority,
  :parameters,
  :retry_strategy,
  :container_properties,
  :timeout,
  :node_properties,
  :tags,
  :propagate_tags,
  :platform_capabilities,
  :ecs_properties,
  :eks_properties,
  :container_orchestration_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Batch::Types::JobDefinition

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#container_orchestration_type ⇒ String

#container_properties ⇒ Types::ContainerProperties

#ecs_properties ⇒ Types::EcsProperties

#eks_properties ⇒ Types::EksProperties

#job_definition_arn ⇒ String

#job_definition_name ⇒ String

#node_properties ⇒ Types::NodeProperties

#parameters ⇒ Hash<String,String>

#platform_capabilities ⇒ Array<String>

#propagate_tags ⇒ Boolean

#retry_strategy ⇒ Types::RetryStrategy

#revision ⇒ Integer

#scheduling_priority ⇒ Integer

#status ⇒ String

#tags ⇒ Hash<String,String>

#timeout ⇒ Types::JobTimeout

#type ⇒ String

#container_orchestration_type ⇒ `String`

#container_properties ⇒ `Types::ContainerProperties`

#ecs_properties ⇒ `Types::EcsProperties`

#eks_properties ⇒ `Types::EksProperties`

#job_definition_arn ⇒ `String`

#job_definition_name ⇒ `String`

#node_properties ⇒ `Types::NodeProperties`

#parameters ⇒ `Hash<String,String>`

#platform_capabilities ⇒ `Array<String>`

#propagate_tags ⇒ `Boolean`

#retry_strategy ⇒ `Types::RetryStrategy`

#revision ⇒ `Integer`

#scheduling_priority ⇒ `Integer`

#status ⇒ `String`

#tags ⇒ `Hash<String,String>`

#timeout ⇒ `Types::JobTimeout`

#type ⇒ `String`