community.aws.ecs_taskdefinition_info module – Describe a task definition in ECS
Note
This module is part of the community.aws collection (version 7.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.ecs_taskdefinition_info.
New in community.aws 1.0.0
Synopsis
Describes a task definition in ECS.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The name of the task definition to get details for |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- community.aws.ecs_taskdefinition_info:
task_definition: test-td
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Returns a list of complex objects representing the containers Returned: success |
|
The command that is passed to the container. Returned: when present |
|
The number of cpu units reserved for the container. Returned: always |
|
When this parameter is true, networking is disabled within the container. Returned: when present |
|
A list of DNS search domains that are presented to the container. Returned: when present |
|
A list of DNS servers that are presented to the container. Returned: when present |
|
A key/value map of labels to add to the container. Returned: when present |
|
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. Returned: when present |
|
The entry point that is passed to the container. Returned: when present |
|
The environment variables to pass to a container. Returned: always |
|
The name of the environment variable. Returned: when present |
|
The value of the environment variable. Returned: when present |
|
Whether this is an essential container or not. Returned: always |
|
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. Returned: when present |
|
The hostname to use in the /etc/hosts entry. Returned: when present |
|
The IP address to use in the /etc/hosts entry. Returned: when present |
|
The FireLens configuration for the container. Returned: when present |
|
The options to use when configuring the log router. Returned: success |
|
The log router. Returned: success |
|
The container health check command and associated configuration parameters for the container. Returned: when present |
|
A string array representing the command that the container runs to determine if it is healthy. Returned: success |
|
The time period in seconds between each health check execution. Returned: success |
|
The number of times to retry a failed health check before the container is considered unhealthy. Returned: success |
|
The optional grace period to provide containers time to bootstrap before failed. Returned: success |
|
The time period in seconds to wait for a health check to succeed before it is considered a failure. Returned: success |
|
The hostname to use for your container. Returned: when present |
|
The image used to start a container. Returned: always |
|
Links to other containers. Returned: when present |
|
The log configuration specification for the container. Returned: when present |
|
The soft limit (in MiB) of memory to reserve for the container. Returned: when present |
|
The mount points for data volumes in your container. Returned: always |
|
The path on the container to mount the host volume at. Returned: when present |
|
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. Returned: when present |
|
The name of the volume to mount. Returned: when present |
|
The name of a container. Returned: always |
|
The configuration options to send to the log driver. Returned: when present |
|
The list of port mappings for the container. Returned: always |
|
The port number on the container. Returned: when present |
|
The port number on the container instance to reserve for your container. Returned: when present |
|
The protocol used for the port mapping. Returned: when present |
|
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). Returned: when present |
|
When this parameter is true, the container is given read-only access to its root file system. Returned: when present |
|
The type and amount of a resource to assign to a container. Returned: when present |
|
The type of resource to assign to a container. Returned: success |
|
The value for the specified resource type. Returned: success |
|
A list of namespaced kernel parameters to set in the container. Returned: when present |
|
TThe namespaced kernel. Returned: success |
|
The value for the namespaced kernel. Returned: success |
|
A list of ulimits to set in the container. Returned: when present |
|
The hard limit for the ulimit type. Returned: when present |
|
The type of the ulimit . Returned: when present |
|
The soft limit for the ulimit type. Returned: when present |
|
The user name to use inside the container. Returned: when present |
|
Data volumes to mount from another container. Returned: always |
|
If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. Returned: when present |
|
The name of another container within the same task definition to mount volumes from. Returned: when present |
|
The working directory in which to run commands inside the container. Returned: when present |
|
The family of your task definition, used as the definition name Returned: always |
|
Network mode for the containers Returned: always |
|
A list of placement constraint objects to use for tasks Returned: always |
|
A cluster query language expression to apply to the constraint. Returned: when present |
|
The type of constraint. Returned: when present |
|
The container instance attributes required by your task Returned: when present |
|
The name of the attribute. Returned: when present |
|
The ID of the target. Returned: when present |
|
The type of the target with which to attach the attribute. Returned: when present |
|
The value of the attribute. Returned: when present |
|
Revision number that was queried Returned: always |
|
The status of the task definition Returned: always |
|
ARN of the task definition Returned: always |
|
The ARN of the IAM role that containers in this task can assume Returned: when role is set |
|
The list of volumes in a task Returned: always |
|
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. Returned: when present |
|
The name of the volume. Returned: when present |
|
The path on the host container instance that is presented to the container. Returned: when present |