community.aws.ecs_cluster module – Create or terminate ECS clusters.
Note
This module is part of the community.aws collection (version 7.2.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.ecs_cluster.
New in community.aws 1.0.0
Synopsis
Creates or terminates ecs clusters.
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 |
|---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
List of capacity provider strategies to use for the cluster. |
|
How many tasks, at a minimum, should use the specified provider. Default: |
|
Name of capacity provider. |
|
The relative percentage of the total number of launched tasks that should use the specified provider. |
|
List of capacity providers to use for the cluster. |
|
Use a The Choices:
|
|
Number of seconds to wait. Default: |
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The cluster name. |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
Toggle overwriting of existing capacity providers or strategy. This is needed for backwards compatibility. By default purge_capacity_providers=false. In a release after 2024-06-01 this will be changed to purge_capacity_providers=true. Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
The number of times to wait for the cluster to have an instance. Default: |
|
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 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 |
|
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 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 |
|
The desired state of the cluster. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
When deleting a cluster, the information returned is the state of the cluster prior to deletion.
It will also wait for a cluster to have instances registered to it.
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
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Cluster creation
community.aws.ecs_cluster:
name: default
state: present
- name: Cluster creation with capacity providers and strategies.
community.aws.ecs_cluster:
name: default
state: present
capacity_providers:
- FARGATE
- FARGATE_SPOT
capacity_provider_strategy:
- capacity_provider: FARGATE
base: 1
weight: 1
- capacity_provider: FARGATE_SPOT
weight: 100
purge_capacity_providers: true
- name: Cluster deletion
community.aws.ecs_cluster:
name: default
state: absent
- name: Wait for register
community.aws.ecs_cluster:
name: "{{ new_cluster }}"
state: has_instances
delay: 10
repeat: 10
register: task_output
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
how many services are active in this cluster Returned: 0 if a new cluster |
|
list of capacity providers used in this cluster Returned: always |
|
the ARN of the cluster just created Returned: 0 if a new cluster Sample: |
|
name of the cluster just created (should match the input argument) Returned: always Sample: |
|
list of capacity provider strategies used in this cluster Returned: always |
|
how many tasks are waiting to run in this cluster Returned: 0 if a new cluster |
|
how many container instances are available in this cluster Returned: 0 if a new cluster |
|
how many tasks are running in this cluster Returned: 0 if a new cluster |
|
the status of the new cluster Returned: always Sample: |