Documentation

ecs_cluster - create or terminate ecs clusters

New in version 2.0.

Synopsis

Creates or terminates ecs clusters.

Requirements (on host that executes module)

  • boto
  • boto3
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
    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.

    aliases: ec2_access_key, access_key
    aws_secret_key
    		 no
      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.

      aliases: ec2_secret_key, secret_key
      delay
      		 no
        Number of seconds to wait
        ec2_url
        		 no
          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.
          name
          		 yes
            The cluster name
            profile
            (added in 1.6)
            		 no
              uses a boto profile. Only works with boto >= 2.24.0
              region
              		 no
                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

                aliases: aws_region, ec2_region
                repeat
                		 no
                  The number of times to wait for the cluster to have an instance
                  security_token
                  (added in 1.6)
                  		 no
                    AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

                    aliases: access_token
                    state
                    		 yes
                    • present
                    • absent
                    • has_instances
                    The desired state of the cluster
                    validate_certs
                    (added in 1.5)
                    		 no yes
                    • yes
                    • no
                    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

                    Examples

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

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

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

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

                    Return Values

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

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


                    Notes

                    Note

                    When deleting a cluster, the information returned is the state of the cluster prior to deletion.

                    Note

                    It will also wait for a cluster to have instances registered to it.

                    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_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

                    Note

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

                    Note

                    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

                    This is an Extras Module

                    For more information on what this means please read Extras Modules

                    For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.