Class: Ansible::Ruby::Modules::Aws_batch_job_definition

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Aws_batch_job_definition

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb

Overview

This module allows the management of AWS Batch Job Definitions. It is idempotent and supports “Check” mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Instance Method Summary

• #attempts ⇒ Integer^?

  Retry strategy - The number of times to move a job to the RUNNABLE status.

• #command ⇒ Array<String>, ...

  The command that is passed to the container.

• #environment ⇒ Object^?

  The environment variables to pass to a container.

• #image ⇒ String^?

  The image used to start a container.

• #job_definition_arn ⇒ Object^?

  The arn for the job definition.

• #job_definition_name ⇒ String

  The name for the job definition.

• #job_role_arn ⇒ String^?

  The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

• #memory ⇒ Integer^?

  The hard limit (in MiB) of memory to present to the container.

• #mount_points ⇒ Object^?

  The mount points for data volumes in your container.

• #parameters ⇒ Hash^?

  Default parameter substitution placeholders to set in the job definition.

• #privileged ⇒ Object^?

  When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

• #readonly_root_filesystem ⇒ Object^?

  When this parameter is true, the container is given read-only access to its root file system.

• #state ⇒ :present, :absent

  Describes the desired state.

• #type ⇒ String

  The type of job definition.

• #ulimits ⇒ Object^?

  A list of ulimits to set in the container.

• #user ⇒ Object^?

  The user name to use inside the container.

• #vcpus ⇒ Integer^?

  The number of vCPUs reserved for the container.

• #volumes ⇒ Object^?

  A list of data volumes used in a job.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#attempts ⇒ Integer^?

Returns Retry strategy - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

Returns:

• (Integer, nil) —

  Retry strategy - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 72

attribute :attempts

#command ⇒ Array<String>, ...

Returns The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see docs.docker.com/engine/reference/builder/#cmd.

Returns:

• (Array<String>, String, nil) —

  The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see docs.docker.com/engine/reference/builder/#cmd.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 43

attribute :command

#environment ⇒ Object^?

Returns The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run. List of dictionaries.

Returns:

• (Object, nil) —

  The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the –env option to docker run. List of dictionaries.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 54

attribute :environment

#image ⇒ String^?

Returns The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with “ repository-url /image <colon>tag “. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Returns:

• (String, nil) —

  The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with “ repository-url /image <colon>tag “. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 31

attribute :image

#job_definition_arn ⇒ Object^?

Returns The arn for the job definition.

Returns:

• (Object, nil) —

  The arn for the job definition

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 12

attribute :job_definition_arn

#job_definition_name ⇒ String

Returns The name for the job definition.

Returns:

• (String) —

  The name for the job definition

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 15

attribute :job_definition_name

#job_role_arn ⇒ String^?

Returns The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

Returns:

• (String, nil) —

  The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 47

attribute :job_role_arn

#memory ⇒ Integer^?

Returns The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

Returns:

• (Integer, nil) —

  The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the –memory option to docker run.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 39

attribute :memory

#mount_points ⇒ Object^?

Returns The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run. List of dictionaries.

Returns:

• (Object, nil) —

  The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the –volume option to docker run. List of dictionaries.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 57

attribute :mount_points

#parameters ⇒ Hash^?

Returns 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, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 27

attribute :parameters

#privileged ⇒ Object^?

Returns When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

Returns:

• (Object, nil) —

  When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the –privileged option to docker run.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 63

attribute :privileged

#readonly_root_filesystem ⇒ Object^?

Returns When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

Returns:

• (Object, nil) —

  When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the –read-only option to docker run.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 60

attribute :readonly_root_filesystem

#state ⇒ :present, :absent

Returns Describes the desired state.

Returns:

• (:present, :absent) —

  Describes the desired state.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 19

attribute :state

#type ⇒ String

Returns The type of job definition.

Returns:

• (String) —

  The type of job definition

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 23

attribute :type

#ulimits ⇒ Object^?

Returns A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. List of dictionaries.

Returns:

• (Object, nil) —

  A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the –ulimit option to docker run. List of dictionaries.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 66

attribute :ulimits

#user ⇒ Object^?

Returns The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

Returns:

• (Object, nil) —

  The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the –user option to docker run.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 69

attribute :user

#vcpus ⇒ Integer^?

Returns The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.

Returns:

• (Integer, nil) —

  The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the –cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 35

attribute :vcpus

#volumes ⇒ Object^?

Returns A list of data volumes used in a job. List of dictionaries.

Returns:

• (Object, nil) —

  A list of data volumes used in a job. List of dictionaries.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_batch_job_definition.rb', line 51

attribute :volumes