community / community.aws / 5.1.0 / module / ecs_task Run, start or stop a task in ECS | "added in version" 1.0.0 of community.aws" Authors: Mark Chance (@Java1Guy)community.aws.ecs_task (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Creates or deletes instances of task definitions.
# Simple example of run task - name: Run task community.aws.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 community.aws.ecs_task: operation: start cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a" tags: resourceName: a_task_for_ansible_to_run type: long_running_task network: internal version: 1.4 container_instances: - arn:aws:ecs:us-west-2:123456789012: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: RUN a task on Fargate community.aws.ecs_task: operation: run cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a" started_by: ansible_user launch_type: FARGATE network_configuration: subnets: - subnet-abcd1234 security_groups: - sg-aaaa1111 - my_security_group register: task_output
- name: RUN a task on Fargate with public ip assigned community.aws.ecs_task: operation: run count: 2 cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a" started_by: ansible_user launch_type: FARGATE network_configuration: assign_public_ip: true subnets: - subnet-abcd1234 register: task_output
- name: Stop a task community.aws.ecs_task: operation: stop cluster: console-sample-app-static-cluster task_definition: console-sample-app-static-taskdef task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
tags: aliases: - resource_tags description: - Tags that will be added to ecs tasks on start and run required: false type: dict task: description: - The ARN of the task to stop. required: false type: str wait: default: false description: - Whether or not to wait for the desired state. type: bool version_added: 4.1.0 version_added_collection: community.aws count: description: - How many new instances to start. required: false type: int region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str cluster: default: default description: - The name of the cluster to run the task on. - If not specified, the cluster name will be C(default). required: false type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str operation: choices: - run - start - stop description: - Which task operation to execute. - When I(operation=run) I(task_definition) must be set. - When I(operation=start) both I(task_definition) and I(container_instances) must be set. - When I(operation=stop) both I(task_definition) and I(task) must be set. required: true type: str overrides: description: - A dictionary of values to pass to the new instances. required: false type: dict access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str started_by: description: - A value showing who or what started the task (for informational purposes). required: false type: str launch_type: choices: - EC2 - FARGATE description: - The launch type on which to run your service. required: false type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool task_definition: description: - The task definition to start, run or stop. required: false type: str container_instances: description: - The list of container instances on which to deploy the task. elements: str required: false type: list network_configuration: description: - Network configuration of the service. Only applicable for task definitions created with I(network_mode=awsvpc). suboptions: assign_public_ip: description: Whether the task's elastic network interface receives a public IP address. type: bool version_added: 1.5.0 version_added_collection: community.aws security_groups: description: A list of group names or group IDs for the task. elements: str type: list subnets: description: A list of subnet IDs to which the task is attached. elements: str type: list type: dict debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
task: contains: clusterArn: description: The Amazon Resource Name (ARN) of the of the cluster that hosts the task. returned: only when details is true type: str containerInstanceArn: description: The Amazon Resource Name (ARN) of the container running the task. returned: only when details is true type: str containers: description: The container details. elements: dict returned: only when details is true type: list createdAt: description: The timestamp of when the task was created. returned: only when details is true type: str desiredStatus: description: The desired status of the task. returned: only when details is true type: str lastStatus: description: The last recorded status of the task. returned: only when details is true type: str launchType: description: The launch type on which to run your task. returned: always type: str overrides: description: The container overrides set for this task. elements: dict returned: only when details is true type: list startedAt: description: The timestamp of when the task was started. returned: only when details is true type: str startedBy: description: The used who started the task. returned: only when details is true type: str stoppedAt: description: The timestamp of when the task was stopped. returned: only when details is true type: str stoppedReason: description: The reason why the task was stopped. returned: only when details is true type: str taskArn: description: The Amazon Resource Name (ARN) that identifies the task. returned: always type: str taskDefinitionArn: description: The Amazon Resource Name (ARN) of the task definition. returned: only when details is true type: str description: details about the task that was started returned: success type: complex