ecs_taskdefinition_facts - describe a task definition in ecs

New in version 2.5.

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 Default:
None
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 Default:
None
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
ec2_url Default:
None
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.
profile
(added in 1.6)
 Default:
None
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)
 Default:
None
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
task_definition
required
The name of the task definition to get details for
validate_certs
(added in 1.5)
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- ecs_taskdefinition_facts:
    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
dnsSearchDomains
string
 when present
A list of DNS search domains that are presented to the container.
disableNetworking
bool
 when present
When this parameter is true, networking is disabled within the container.
links
string
 when present
Links to other containers.
mountPoints
complex
 always
The mount points for data volumes in your container.
sourceVolume
string
 when present
The name of the volume to mount.
readOnly
bool
 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.
containerPath
string
 when present
The path on the container to mount the host volume at.
image
string
 always
The image used to start a container.
logConfiguration
string
 when present
The log configuration specification for 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.
user
string
 when present
The user name to use inside the container.
essential
bool
 always
Whether this is an essential container or not.
memoryReservation
int
 when present
The soft limit (in MiB) of memory to reserve for the container.
readonlyRootFilesystem
bool
 when present
When this parameter is true, the container is given read-only access to its root file system.
name
string
 always
The name of a container.
workingDirectory
string
 when present
The working directory in which to run commands inside the container.
hostname
string
 when present
The hostname to use for your container.
dockerLabels
string
 when present
A key/value map of labels to add to the container.
privileged
bool
 when present
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
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.
dnsServers
string
 when present
A list of DNS servers that are presented to the container.
command
string
 when present
The command that is passed to the container.
ulimits
complex
 when present
A list of ulimits to set in the container.
softLimit
int
 when present
The soft limit for the ulimit type.
name
string
 when present
The type of the ulimit .
hardLimit
int
 when present
The hard limit for the ulimit type.
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.
portMappings
complex
 always
The list of port mappings for the container.
protocol
string
 when present
The protocol used for the port mapping.
containerPort
int
 when present
The port number on the container.
hostPort
int
 when present
The port number on the container instance to reserve for your container.
cpu
int
 always
The number of cpu units reserved for the container.
options
string
 when present
The configuration options to send to the log driver.
volumesFrom
complex
 always
Data volumes to mount from another container.
readOnly
bool
 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.
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
type
string
 when present
The type of constraint.
expression
string
 when present
A cluster query language expression to apply to the constraint.
requires_attributes
complex
 when present
The container instance attributes required by your task
targetType
string
 when present
The type of the target with which to attach the attribute.
targetId
string
 when present
The ID of the target.
name
string
 when present
The name of the attribute.
value
string
 when present
The value of the attribute.
revision
int
 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
bool
 when present
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored.
source_path
string
 when present
The path on the host container instance that is presented to the container.
name
string
 when present
The name of the volume.


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Gustavo Maia(@gurumaia)
  • Mark Chance(@Java1Guy)
  • Darek Kaczynski (@kaczynskid)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ecs_taskdefinition_facts_module.html