You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

An object representing an AWS Batch job definition.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#container_properties ⇒ Types::ContainerProperties

An object with various properties specific to container-based jobs.

Returns:

#job_definition_arn ⇒ String

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

Returns:

  • (String) —

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

#job_definition_name ⇒ String

The name of the job definition.

Returns:

  • (String) —

    The name of the job definition.

#node_properties ⇒ Types::NodeProperties

An object with various properties specific to multi-node parallel jobs.

Returns:

#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 AWS Batch User Guide.

Returns:

  • (Hash<String,String>) —

    Default parameters or parameter substitution placeholders that are set in the job definition.

#retry_strategy ⇒ Types::RetryStrategy

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

Returns:

  • (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.

Returns:

  • (Integer) —

    The revision of the job definition.

#status ⇒ String

The status of the job definition.

Returns:

  • (String) —

    The status of the job definition.

#tags ⇒ Hash<String,String>

The tags applied to the job definition.

Returns:

  • (Hash<String,String>) —

    The tags applied to the job definition.

#timeout ⇒ Types::JobTimeout

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

Returns:

  • (Types::JobTimeout) —

    The timeout configuration for jobs that are submitted with this job definition.

#type ⇒ String

The type of job definition.

Returns:

  • (String) —

    The type of job definition.