.. _community.aws.ecs_task_module: ********************** community.aws.ecs_task ********************** **Run, start or stop a task in ecs** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - Creates or deletes instances of task definitions. Requirements ------------ The below requirements are needed on the host that executes this module. - python >= 3.6 - boto3 >= 1.15.0 - botocore >= 1.18.0 Parameters ---------- .. raw:: html
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
aws_access_key
string
|
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.If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
||
|
aws_ca_bundle
path
|
The location of a CA Bundle to use when validating SSL certificates.
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
|
||
|
aws_config
dictionary
|
A dictionary to modify the botocore configuration.
Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
||
|
aws_secret_key
string
|
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.If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
||
|
cluster
string
/ required
|
The name of the cluster to run the task on.
|
||
|
container_instances
list
/ elements=string
|
The list of container instances on which to deploy the task.
|
||
|
count
integer
|
How many new instances to start.
|
||
|
debug_botocore_endpoint_logs
boolean
|
|
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.
|
|
|
ec2_url
string
|
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.
aliases: aws_endpoint_url, endpoint_url |
||
|
launch_type
string
|
|
The launch type on which to run your service.
|
|
|
network_configuration
dictionary
|
Network configuration of the service. Only applicable for task definitions created with network_mode=awsvpc.
|
||
|
assign_public_ip
boolean
added in 1.5.0
|
|
Whether the task's elastic network interface receives a public IP address.
|
|
|
security_groups
list
/ elements=string
|
A list of group names or group IDs for the task.
|
||
|
subnets
list
/ elements=string
|
A list of subnet IDs to which the task is attached.
|
||
|
operation
string
/ required
|
|
Which task operation to execute.
When operation=run task_definition must be set.
When operation=start both task_definition and container_instances must be set.
When operation=stop both task_definition and task must be set.
|
|
|
overrides
dictionary
|
A dictionary of values to pass to the new instances.
|
||
|
profile
string
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
||
|
region
string
|
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
string
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
||
|
started_by
string
|
A value showing who or what started the task (for informational purposes).
|
||
|
tags
dictionary
|
Tags that will be added to ecs tasks on start and run
|
||
|
task
string
|
The ARN of the task to stop.
|
||
|
task_definition
string
|
The task definition to start, run or stop.
|
||
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
|
|