community.aws.aws_batch_compute_environment – Manage AWS Batch Compute Environments

Note

This plugin is part of the community.aws collection (version 1.5.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.

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

New in version 1.0.0: of community.aws

Synopsis

Requirements

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

  • boto

  • boto3

  • python >= 2.6

Parameters

Parameter

Comments

aws_access_key

aliases: ec2_access_key, access_key

string

AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aws_ca_bundle

path

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

Only used for boto3 based modules.

Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally.

aws_config

dictionary

A dictionary to modify the botocore configuration.

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

Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.

aws_secret_key

aliases: ec2_secret_key, secret_key

string

AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

If profile is set this parameter is ignored.

Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

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:

  • no ← (default)

  • yes

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.

ec2_url

aliases: aws_endpoint_url, endpoint_url

string

Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

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

Uses a boto profile. Only works with boto >= 2.24.0.

Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.

aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

region

aliases: aws_region, ec2_region

string

The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

security_group_ids

list / elements=string / required

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

security_token

aliases: aws_security_token, access_token

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

If profile is set this parameter is ignored.

Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

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.

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 “no”, SSL certificates will not be validated for boto versions >= 2.6.0.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

- name: My Batch Compute Environment
  community.aws.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”: {“aws_access_key”: null, “aws_secret_key”: null, “bid_percentage”: null, “compute_environment_name”: “\u003cname\u003e”, “compute_environment_state”: “ENABLED”, “compute_resource_type”: “EC2”, “desiredv_cpus”: 0, “ec2_key_pair”: null, “ec2_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”, “security_group_ids”: [“*******”], “security_token”: null, “service_role”: “arn:aws:iam::….”, “spot_iam_fleet_role”: null, “state”: “present”, “subnets”: [“******”], “tags”: {“Environment”: “\u003cname\u003e”, “Name”: “\u003cname\u003e”}, “type”: “MANAGED”, “validate_certs”: true}}, “response”: {“computeEnvironmentArn”: “arn:aws:batch:….”, “computeEnvironmentName”: “\u003cname\u003e”, “computeResources”: {“desiredvCpus”: 0, “instanceRole”: “arn:aws:iam::…”, “instanceTypes”: [“optimal”], “maxvCpus”: 8, “minvCpus”: 0, “securityGroupIds”: [“******”], “subnets”: [“*******”], “tags”: {“Environment”: “\u003cname\u003e”, “Name”: “\u003cname\u003e”}, “type”: “EC2”}, “ecsClusterArn”: “arn:aws:ecs:…..”, “serviceRole”: “arn:aws:iam::…”, “state”: “ENABLED”, “status”: “VALID”, “statusReason”: “ComputeEnvironment Healthy”, “type”: “MANAGED”}}

Authors

  • Jon Meran (@jonmer85)