Class: Aws::Batch::Types::RegisterJobDefinitionRequest

Inherits:

Struct

Object
Struct
Aws::Batch::Types::RegisterJobDefinitionRequest

show all

Includes:: Structure

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

Overview

Contains the parameters for ‘RegisterJobDefinition`.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#container_properties ⇒ Types::ContainerProperties

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

An object with properties that are specific to Amazon ECS-based jobs.
#eks_properties ⇒ Types::EksProperties

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

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

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

Default parameter substitution placeholders to 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.
#scheduling_priority ⇒ Integer

The scheduling priority for jobs that are submitted with this job definition.
#tags ⇒ Hash<String,String>

The tags that you apply to the job definition to help you categorize and organize your resources.
#timeout ⇒ Types::JobTimeout

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished.
#type ⇒ String

The type of job definition.

Instance Attribute Details

#container_properties ⇒ `Types::ContainerProperties`

An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition’s ‘type` parameter is `container`, then you must specify either `containerProperties` or `nodeProperties`. This must not be specified for Amazon EKS-based job definitions.

<note markdown=“1”> If the job runs on Fargate resources, then you must not specify ‘nodeProperties`; use only `containerProperties`.

</note>

Returns:

(Types::ContainerProperties)

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

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

#ecs_properties ⇒ `Types::EcsProperties`

An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.

Returns:

(Types::EcsProperties)

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

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

#eks_properties ⇒ `Types::EksProperties`

An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.

Returns:

(Types::EksProperties)

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

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

#job_definition_name ⇒ `String`

The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Returns:

(String)

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

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

#node_properties ⇒ `Types::NodeProperties`

An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see [Multi-node Parallel Jobs] in the *Batch User Guide*.

<note markdown=“1”> If the job runs on Fargate resources, then you must not specify ‘nodeProperties`; use `containerProperties` instead.

</note>

<note markdown=“1”> If the job runs on Amazon EKS resources, then you must not specify ‘nodeProperties`.

</note>

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

Returns:

(Types::NodeProperties)

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

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

#parameters ⇒ `Hash<String,String>`

Default parameter substitution placeholders to 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.

Returns:

(Hash<String,String>)

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

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :scheduling_priority,
  :container_properties,
  :node_properties,
  :retry_strategy,
  :propagate_tags,
  :timeout,
  :tags,
  :platform_capabilities,
  :eks_properties,
  :ecs_properties)
  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`. To run the job on Fargate resources, specify `FARGATE`.

<note markdown=“1”> If the job runs on Amazon EKS resources, then you must not specify ‘platformCapabilities`.

</note>

Returns:

(Array<String>)

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

class RegisterJobDefinitionRequest < Struct.new(
  :job_definition_name,
  :type,
  :parameters,
  :scheduling_priority,
  :container_properties,
  :node_properties,
  :retry_strategy,
  :propagate_tags,
  :timeout,
  :tags,
  :platform_capabilities,
  :eks_properties,
  :ecs_properties)
  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 are not propagated. Tags can only be propagated to the tasks during task creation. 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.

<note markdown=“1”> If the job runs on Amazon EKS resources, then you must not specify ‘propagateTags`.

</note>

Returns:

(Boolean)

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

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

#retry_strategy ⇒ `Types::RetryStrategy`

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that’s specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn’t retried.

Returns:

(Types::RetryStrategy)

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

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

#scheduling_priority ⇒ `Integer`

The scheduling priority for jobs that are submitted with this 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.

The minimum supported value is 0 and the maximum supported value is 9999.

Returns:

(Integer)

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

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

#tags ⇒ `Hash<String,String>`

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see [Tagging Amazon Web Services Resources] in *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/using-tags.html

Returns:

(Hash<String,String>)

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

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

#timeout ⇒ `Types::JobTimeout`

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn’t retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that’s specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see [Job Timeouts] in the *Batch User Guide*.

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

Returns:

(Types::JobTimeout)

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

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

#type ⇒ `String`

The type of job definition. For more information about multi-node parallel jobs, see [Creating a multi-node parallel job definition] in the *Batch User Guide*.

If the value is ‘container`, then one of the following is required: `containerProperties`, `ecsProperties`, or `eksProperties`.
If the value is ‘multinode`, then `nodeProperties` is required.

<note markdown=“1”> If the job is run on Fargate resources, then ‘multinode` isn’t supported.

</note>

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

Returns:

(String)

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

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

Class: Aws::Batch::Types::RegisterJobDefinitionRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#container_properties ⇒ Types::ContainerProperties

#ecs_properties ⇒ Types::EcsProperties

#eks_properties ⇒ Types::EksProperties

#job_definition_name ⇒ String

#node_properties ⇒ Types::NodeProperties

#parameters ⇒ Hash<String,String>

#platform_capabilities ⇒ Array<String>

#propagate_tags ⇒ Boolean

#retry_strategy ⇒ Types::RetryStrategy

#scheduling_priority ⇒ Integer

#tags ⇒ Hash<String,String>

#timeout ⇒ Types::JobTimeout

#type ⇒ String

#container_properties ⇒ `Types::ContainerProperties`

#ecs_properties ⇒ `Types::EcsProperties`

#eks_properties ⇒ `Types::EksProperties`

#job_definition_name ⇒ `String`

#node_properties ⇒ `Types::NodeProperties`

#parameters ⇒ `Hash<String,String>`

#platform_capabilities ⇒ `Array<String>`

#propagate_tags ⇒ `Boolean`

#retry_strategy ⇒ `Types::RetryStrategy`

#scheduling_priority ⇒ `Integer`

#tags ⇒ `Hash<String,String>`

#timeout ⇒ `Types::JobTimeout`

#type ⇒ `String`