community.aws.ecs_taskdefinition_info – Describe a task definition in ECS

Note

This plugin is part of the community.aws collection.

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.ecs_taskdefinition_info.

New in version 1.0.0: of community.aws

Synopsis

  • Describes a task definition in ECS.

Requirements

The below requirements are needed on the host that executes this module.

  • boto

  • boto3

  • botocore

  • json

  • python >= 2.6

Parameters

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.
Only used for boto3 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.
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
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
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
task_definition
string / required
The name of the task definition to get details for
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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

  • This module was called ecs_taskdefinition_facts before Ansible 2.9. The usage did not change.

  • 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_PROFILE or AWS_DEFAULT_PROFILE, 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_CA_BUNDLE

  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html

  • 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

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 Returned Description
container_definitions
complex
success
Returns a list of complex objects representing the containers

 
command
string
when present
The command that is passed to the container.

 
cpu
integer
always
The number of cpu units reserved for the container.

 
disableNetworking
boolean
when present
When this parameter is true, networking is disabled within the container.

 
dnsSearchDomains
string
when present
A list of DNS search domains that are presented to the container.

 
dnsServers
string
when present
A list of DNS servers that are presented to the container.

 
dockerLabels
string
when present
A key/value map of labels to add to the container.

 
dockerSecurityOptions
string
when present
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

 
entryPoint
string
when present
The entry point that is passed to the container.

 
environment
complex
always
The environment variables to pass to a container.

   
name
string
when present
The name of the environment variable.

   
value
string
when present
The value of the environment variable.

 
essential
boolean
always
Whether this is an essential container or not.

 
extraHosts
complex
when present
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.

   
hostname
string
when present
The hostname to use in the /etc/hosts entry.

   
ipAddress
string
when present
The IP address to use in the /etc/hosts entry.

 
hostname
string
when present
The hostname to use for your container.

 
image
string
always
The image used to start a container.

  links
string
when present
Links to other containers.

 
logConfiguration
string
when present
The log configuration specification for the container.

 
memoryReservation
integer
when present
The soft limit (in MiB) of memory to reserve for the container.

 
mountPoints
complex
always
The mount points for data volumes in your container.

   
containerPath
string
when present
The path on the container to mount the host volume at.

   
readOnly
boolean
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.

   
sourceVolume
string
when present
The name of the volume to mount.

 
name
string
always
The name of a container.

 
options
string
when present
The configuration options to send to the log driver.

 
portMappings
complex
always
The list of port mappings for the container.

   
containerPort
integer
when present
The port number on the container.

   
hostPort
integer
when present
The port number on the container instance to reserve for your container.

   
protocol
string
when present
The protocol used for the port mapping.

 
privileged
boolean
when present
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

 
readonlyRootFilesystem
boolean
when present
When this parameter is true, the container is given read-only access to its root file system.

 
ulimits
complex
when present
A list of ulimits to set in the container.

   
hardLimit
integer
when present
The hard limit for the ulimit type.

   
name
string
when present
The type of the ulimit .

   
softLimit
integer
when present
The soft limit for the ulimit type.

 
user
string
when present
The user name to use inside the container.

 
volumesFrom
complex
always
Data volumes to mount from another container.

   
readOnly
boolean
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.

   
sourceContainer
string
when present
The name of another container within the same task definition to mount volumes from.

 
workingDirectory
string
when present
The working directory in which to run commands inside the container.

family
string
always
The family of your task definition, used as the definition name

network_mode
string
always
Network mode for the containers

placement_constraints
complex
always
A list of placement constraint objects to use for tasks

 
expression
string
when present
A cluster query language expression to apply to the constraint.

 
type
string
when present
The type of constraint.

requires_attributes
complex
when present
The container instance attributes required by your task

 
name
string
when present
The name of the attribute.

 
targetId
string
when present
The ID of the target.

 
targetType
string
when present
The type of the target with which to attach the attribute.

 
value
string
when present
The value of the attribute.

revision
integer
always
Revision number that was queried

status
string
always
The status of the task definition

task_definition_arn
string
always
ARN of the task definition

task_role_arn
string
when role is set
The ARN of the IAM role that containers in this task can assume

volumes
complex
always
The list of volumes in a task

 
host
boolean
when present
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored.

 
name
string
when present
The name of the volume.

 
source_path
string
when present
The path on the host container instance that is presented to the container.



Authors

  • Gustavo Maia (@gurumaia)

  • Mark Chance (@Java1Guy)

  • Darek Kaczynski (@kaczynskid)