community.aws.batch_compute_environment module – Manage AWS Batch Compute Environments

Note

This module is part of the community.aws collection (version 8.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.aws.batch_compute_environment.

New in community.aws 1.0.0

Synopsis

Aliases: aws_batch_compute_environment

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.26.0

  • botocore >= 1.29.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

bid_percentage

integer

The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched.

For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

compute_environment_name

string / required

The name for your compute environment.

Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

compute_environment_state

string

The state of the compute environment.

If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

Choices:

  • "ENABLED" ← (default)

  • "DISABLED"

compute_resource_type

string / required

The type of compute resource.

Choices:

  • "EC2"

  • "SPOT"

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

desiredv_cpus

integer

The desired number of EC2 vCPUS in the compute environment.

ec2_key_pair

string

The EC2 key pair that is used for instances launched in the compute environment.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

image_id

string

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

instance_role

string / required

The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.

instance_types

list / elements=string / required

The instance types that may be launched.

maxv_cpus

integer / required

The maximum number of EC2 vCPUs that an environment can reach.

minv_cpus

integer / required

The minimum number of EC2 vCPUs that an environment should maintain.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

security_group_ids

list / elements=string / required

The EC2 security groups that are associated with instances launched in the compute environment.

service_role

string / required

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

spot_iam_fleet_role

string

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

state

string

Describes the desired state.

Choices:

  • "present" ← (default)

  • "absent"

subnets

list / elements=string / required

The VPC subnets into which the compute resources are launched.

tags

dictionary

Key-value pair tags to be applied to resources that are launched in the compute environment.

type

string / required

The type of the compute environment.

Choices:

  • "MANAGED"

  • "UNMANAGED"

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: My Batch Compute Environment
  community.aws.batch_compute_environment:
    compute_environment_name: computeEnvironmentName
    state: present
    region: us-east-1
    compute_environment_state: ENABLED
    type: MANAGED
    compute_resource_type: EC2
    minv_cpus: 0
    maxv_cpus: 2
    desiredv_cpus: 1
    instance_types:
      - optimal
    subnets:
      - my-subnet1
      - my-subnet2
    security_group_ids:
      - my-sg1
      - my-sg2
    instance_role: arn:aws:iam::<account>:instance-profile/<role>
    tags:
      tag1: value1
      tag2: value2
    service_role: arn:aws:iam::<account>:role/service-role/<role>
  register: aws_batch_compute_environment_action

- name: show results
  ansible.builtin.debug:
    var: aws_batch_compute_environment_action

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

output

dictionary

returns what action was taken, whether something was changed, invocation and response

Returned: always

Sample: {"batch_compute_environment_action": "none", "changed": false, "invocation": {"module_args": {"access_key": null, "bid_percentage": null, "compute_environment_name": "<name>", "compute_environment_state": "ENABLED", "compute_resource_type": "EC2", "desiredv_cpus": 0, "ec2_key_pair": null, "endpoint_url": null, "image_id": null, "instance_role": "arn:aws:iam::...", "instance_types": ["optimal"], "maxv_cpus": 8, "minv_cpus": 0, "profile": null, "region": "us-east-1", "secret_key": null, "security_group_ids": ["*******"], "security_token": null, "service_role": "arn:aws:iam::....", "spot_iam_fleet_role": null, "state": "present", "subnets": ["******"], "tags": {"Environment": "<name>", "Name": "<name>"}, "type": "MANAGED", "validate_certs": true}}, "response": {"computeEnvironmentArn": "arn:aws:batch:....", "computeEnvironmentName": "<name>", "computeResources": {"desiredvCpus": 0, "instanceRole": "arn:aws:iam::...", "instanceTypes": ["optimal"], "maxvCpus": 8, "minvCpus": 0, "securityGroupIds": ["******"], "subnets": ["*******"], "tags": {"Environment": "<name>", "Name": "<name>"}, "type": "EC2"}, "ecsClusterArn": "arn:aws:ecs:.....", "serviceRole": "arn:aws:iam::...", "state": "ENABLED", "status": "VALID", "statusReason": "ComputeEnvironment Healthy", "type": "MANAGED"}}

Authors

  • Jon Meran (@jonmer85)