ansible.builtin.ecs_cluster (v2.7.18) — module

Install Ansible via pip

Install with pip install ansible==2.7.18

Description

Creates or terminates ecs clusters.

Requirements

• boto
• boto3
• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Cluster creation
- ecs_cluster:
    name: default
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Cluster deletion
- ecs_cluster:
    name: default
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Wait for register
  ecs_cluster:
    name: "{{ new_cluster }}"
    state: has_instances
    delay: 10
    repeat: 10
  register: task_output

Inputs

    
name:
    description:
    - The cluster name
    required: true

delay:
    description:
    - Number of seconds to wait
    required: false

state:
    choices:
    - present
    - absent
    - has_instances
    description:
    - The desired state of the cluster
    required: true

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
    type: str

repeat:
    description:
    - The number of times to wait for the cluster to have an instance
    required: false

ec2_url:
    description:
    - 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.
    type: str

profile:
    description:
    - Uses a boto profile. Only works with boto >= 2.24.0.
    type: str

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
      for more boto configuration.
    type: dict

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - 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.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - 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.
    type: str

security_token:
    aliases:
    - access_token
    description:
    - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
      environment variable is used.
    type: str

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
    type: bool

debug_botocore_endpoint_logs:
    default: 'no'
    description:
    - 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.
    type: bool

Outputs

activeServicesCount:
  description: how many services are active in this cluster
  returned: 0 if a new cluster
  type: int
clusterArn:
  description: the ARN of the cluster just created
  returned: 0 if a new cluster
  sample: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok
  type: string
clusterName:
  description: name of the cluster just created (should match the input argument)
  returned: always
  sample: test-cluster-mfshcdok
  type: string
pendingTasksCount:
  description: how many tasks are waiting to run in this cluster
  returned: 0 if a new cluster
  type: int
registeredContainerInstancesCount:
  description: how many container instances are available in this cluster
  returned: 0 if a new cluster
  type: int
runningTasksCount:
  description: how many tasks are running in this cluster
  returned: 0 if a new cluster
  type: int
status:
  description: the status of the new cluster
  returned: always
  sample: ACTIVE
  type: string