Documentation

ecs_taskdefinition - register a task definition in ecs

New in version 2.0.

Synopsis

Creates or terminates task definitions

Requirements (on host that executes module)

  • boto
  • boto3
  • botocore
  • json
  • python >= 2.6

Options

parameter required default choices comments
arn
 no
    The arn of the task description to delete
    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
        containers
        		 no
          A list of containers definitions
          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.
            family
            		 no
              A Name that would be given to the task definition
              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
                  revision
                  		 no
                    A revision number for the task definition
                    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
                      State whether the task definition should exist or be deleted
                      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.
                      volumes
                      		 no
                        A list of names of volumes to be attached

                        Examples

                        - name: "Create task definition"
  ecs_taskdefinition:
    containers:
    - name: simple-app
      cpu: 10
      essential: true
      image: "httpd:2.4"
      memory: 300
      mountPoints:
      - containerPath: /usr/local/apache2/htdocs
        sourceVolume: my-vol
      portMappings:
      - containerPort: 80
        hostPort: 80
    - name: busybox
      command:
        - "/bin/sh -c "while true; do echo '<html> <head> <title>Amazon ECS Sample App</title> <style>body {margin-top: 40px; background-color: #333;} </style> </head><body> <div style=color:white;text-align:center> <h1>Amazon ECS Sample App</h1> <h2>Congratulations!</h2> <p>Your application is now running on a container in Amazon ECS.</p>' > top; /bin/date > date ; echo '</div></body></html>' > bottom; cat top date bottom > /usr/local/apache2/htdocs/index.html ; sleep 1; done""
      cpu: 10
      entryPoint:
      - sh
      - "-c"
      essential: false
      image: busybox
      memory: 200
      volumesFrom:
      - sourceContainer: simple-app
    volumes:
    - name: my-vol
    family: test-cluster-taskdef
    state: present
  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
                        taskdefinition a reflection of the input parameters dict inputs plus revision, status, taskDefinitionArn


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