New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
aws_access_key | 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 | 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 | |
cluster | The name of the cluster to run the task on | |
container_instances | The list of container instances on which to deploy the task | |
count | How many new instances to start | |
ec2_url | 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. | |
network_configuration (added in 2.6) | network configuration of the service. Only applicable for task definitions created with awsvpc network_mode.
network_configuration has two keys, subnets, a list of subnet IDs to which the task is attached and security_groups, a list of group names or group IDs for the task | |
operation required |
| Which task operation to execute |
overrides | A dictionary of values to pass to the new instances | |
profile (added in 1.6) | Uses a boto profile. Only works with boto >= 2.24.0. | |
region | 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 | |
security_token (added in 1.6) | 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 | |
started_by | A value showing who or what started the task (for informational purposes) | |
task | The task to stop | |
task_definition | The task definition to start or run | |
validate_certs bool (added in 1.5) |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
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
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# Simple example of run task - name: Run task ecs_task: operation: run cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef count: 1 started_by: ansible_user register: task_output # Simple example of start task - name: Start a task ecs_task: operation: start cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a" container_instances: - arn:aws:ecs:us-west-2:172139249013:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8 started_by: ansible_user network_configuration: subnets: - subnet-abcd1234 security_groups: - sg-aaaa1111 - my_security_group register: task_output - name: Stop a task ecs_task: operation: stop cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
task complex | success | details about the tast that was started | |
taskArn string | always | The Amazon Resource Name (ARN) that identifies the task. | |
overrides list of complex | only when details is true | The container overrides set for this task. | |
lastStatus string | only when details is true | The last recorded status of the task. | |
containerInstanceArn string | only when details is true | The Amazon Resource Name (ARN) of the container running the task. | |
containers list of complex | only when details is true | The container details. | |
clusterArn string | only when details is true | The Amazon Resource Name (ARN) of the of the cluster that hosts the task. | |
desiredStatus string | only when details is true | The desired status of the task. | |
startedAt string | only when details is true | The timestamp of when the task was started. | |
stoppedReason string | only when details is true | The reason why the task was stopped. | |
taskDefinitionArn string | only when details is true | The Amazon Resource Name (ARN) of the task definition. | |
startedBy string | only when details is true | The used who started the task. | |
createdAt string | only when details is true | The timestamp of when the task was created. | |
stoppedAt string | only when details is true | The timestamp of when the task was stopped. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ecs_task_module.html