Try SpotterManage AWS Batch Job Definitions
| "added in version" 2.5 of ansible.builtin"
Authors: Jon Meran (@jonmer85)
preview | supported by community
pipInstall with pip install ansible==2.5.10
This module allows the management of AWS Batch Job Definitions. It is idempotent and supports "Check" mode. Use module M(batch_compute_environment) to manage the compute environment, M(batch_job_queue) to manage job queues, M(batch_job_definition) to manage job definitions.
---
- hosts: localhost
gather_facts: no
vars:
state: present
tasks:
- name: My Batch Job Definition
batch_job_definition:
job_definition_name: My Batch Job Definition
state: present
type: container
parameters:
Param1: Val1
Param2: Val2
image: <Docker Image URL>
vcpus: 1
memory: 512
command:
- python
- run_my_script.py
- arg1
job_role_arn: <Job Role ARN>
attempts: 3
register: job_definition_create_result
- name: show results debug: var=job_definition_create_result
type:
description:
- The type of job definition
required: true
user:
description:
- 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.
image:
description:
- 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.
state:
choices:
- present
- absent
default: present
description:
- Describes the desired state.
required: true
vcpus:
description:
- 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.
memory:
description:
- 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.
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
command:
description:
- 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 https://docs.docker.com/engine/reference/builder/#cmd.
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
ulimits:
description:
- 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.
suboptions:
hardLimit:
description:
- The hard limit for the ulimit type.
name:
description:
- The type of the ulimit.
softLimit:
description:
- The soft limit for the ulimit type.
volumes:
description:
- A list of data volumes used in a job. List of dictionaries.
suboptions:
host:
description:
- The contents of the host parameter determine whether your data volume persists
on the host container instance and where it is stored. If the host parameter
is empty, then the Docker daemon assigns a host path for your data volume, but
the data is not guaranteed to persist after the containers associated with it
stop running. This is a dictionary with one property, sourcePath - The path
on the host container instance that is presented to the container. If this parameter
is empty,then the Docker daemon has assigned a host path for you. If the host
parameter contains a sourcePath file location, then the data volume persists
at the specified location on the host container instance until you delete it
manually. If the sourcePath value does not exist on the host container instance,
the Docker daemon creates it. If the location does exist, the contents of the
source path folder are exported.
name:
description:
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers,
hyphens, and underscores are allowed. This name is referenced in the sourceVolume
parameter of container definition mountPoints.
attempts:
description:
- 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.
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
parameters:
description:
- 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.
privileged:
description:
- 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.
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
environment:
description:
- 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.
suboptions:
name:
description:
- The name of the key value pair. For environment variables, this is the name
of the environment variable.
value:
description:
- The value of the key value pair. For environment variables, this is the value
of the environment variable.
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
job_role_arn:
description:
- The Amazon Resource Name (ARN) of the IAM role that the container can assume for
AWS permissions.
mount_points:
description:
- 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.
suboptions:
containerPath:
description:
- The path on the container at which to mount the host volume.
readOnly:
description:
- If this value is true , the container has read-only access to the volume; otherwise,
the container can write to the volume. The default value is false.
sourceVolume:
description:
- The name of the volume to mount.
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
job_definition_arn:
description:
- The arn for the job definition
job_definition_name:
description:
- The name for the job definition
required: true
readonly_root_filesystem:
description:
- 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.
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
output:
description: returns what action was taken, whether something was changed, invocation
and response
returned: always
sample:
batch_job_definition_action: none
changed: false
response:
job_definition_arn: arn:aws:batch:....
job_definition_name: <name>
status: INACTIVE
type: container
type: dict