Try SpotterDescribe a task definition in ECS
| "added in version" 1.0.0 of community.aws"
Authors: Gustavo Maia (@gurumaia), Mark Chance (@Java1Guy), Darek Kaczynski (@kaczynskid)
Install with ansible-galaxy collection install community.aws:==5.1.0
collections:
- name: community.aws
version: 5.1.0Describes a task definition in ECS.
# Note: These examples do not set authentication details, see the AWS Guide for details.
- community.aws.ecs_taskdefinition_info:
task_definition: test-td
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
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
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
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 name of the task definition to get details for
required: true
type: str
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
container_definitions:
contains:
command:
description: The command that is passed to the container.
returned: when present
type: str
cpu:
description: The number of cpu units reserved for the container.
returned: always
type: int
disableNetworking:
description: When this parameter is true, networking is disabled within the
container.
returned: when present
type: bool
dnsSearchDomains:
description: A list of DNS search domains that are presented to the container.
returned: when present
type: str
dnsServers:
description: A list of DNS servers that are presented to the container.
returned: when present
type: str
dockerLabels:
description: A key/value map of labels to add to the container.
returned: when present
type: str
dockerSecurityOptions:
description: A list of strings to provide custom labels for SELinux and AppArmor
multi-level security systems.
returned: when present
type: str
entryPoint:
description: The entry point that is passed to the container.
returned: when present
type: str
environment:
contains:
name:
description: The name of the environment variable.
returned: when present
type: str
value:
description: The value of the environment variable.
returned: when present
type: str
description: The environment variables to pass to a container.
returned: always
type: complex
essential:
description: Whether this is an essential container or not.
returned: always
type: bool
extraHosts:
contains:
hostname:
description: The hostname to use in the /etc/hosts entry.
returned: when present
type: str
ipAddress:
description: The IP address to use in the /etc/hosts entry.
returned: when present
type: str
description: A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container.
returned: when present
type: complex
hostname:
description: The hostname to use for your container.
returned: when present
type: str
image:
description: The image used to start a container.
returned: always
type: str
links:
description: Links to other containers.
returned: when present
type: str
logConfiguration:
description: The log configuration specification for the container.
returned: when present
type: str
memoryReservation:
description: The soft limit (in MiB) of memory to reserve for the container.
returned: when present
type: int
mountPoints:
contains:
containerPath:
description: The path on the container to mount the host volume at.
returned: when present
type: str
readOnly:
description: 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
type: bool
sourceVolume:
description: The name of the volume to mount.
returned: when present
type: str
description: The mount points for data volumes in your container.
returned: always
type: complex
name:
description: The name of a container.
returned: always
type: str
options:
description: The configuration options to send to the log driver.
returned: when present
type: str
portMappings:
contains:
containerPort:
description: The port number on the container.
returned: when present
type: int
hostPort:
description: The port number on the container instance to reserve for your
container.
returned: when present
type: int
protocol:
description: The protocol used for the port mapping.
returned: when present
type: str
description: The list of port mappings for the container.
returned: always
type: complex
privileged:
description: When this parameter is true, the container is given elevated privileges
on the host container instance (similar to the root user).
returned: when present
type: bool
readonlyRootFilesystem:
description: When this parameter is true, the container is given read-only access
to its root file system.
returned: when present
type: bool
ulimits:
contains:
hardLimit:
description: The hard limit for the ulimit type.
returned: when present
type: int
name:
description: The type of the ulimit .
returned: when present
type: str
softLimit:
description: The soft limit for the ulimit type.
returned: when present
type: int
description: A list of ulimits to set in the container.
returned: when present
type: complex
user:
description: The user name to use inside the container.
returned: when present
type: str
volumesFrom:
contains:
readOnly:
description: 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
type: bool
sourceContainer:
description: The name of another container within the same task definition
to mount volumes from.
returned: when present
type: str
description: Data volumes to mount from another container.
returned: always
type: complex
workingDirectory:
description: The working directory in which to run commands inside the container.
returned: when present
type: str
description: Returns a list of complex objects representing the containers
returned: success
type: complex
family:
description: The family of your task definition, used as the definition name
returned: always
type: str
network_mode:
description: Network mode for the containers
returned: always
type: str
placement_constraints:
contains:
expression:
description: A cluster query language expression to apply to the constraint.
returned: when present
type: str
type:
description: The type of constraint.
returned: when present
type: str
description: A list of placement constraint objects to use for tasks
returned: always
type: complex
requires_attributes:
contains:
name:
description: The name of the attribute.
returned: when present
type: str
targetId:
description: The ID of the target.
returned: when present
type: str
targetType:
description: The type of the target with which to attach the attribute.
returned: when present
type: str
value:
description: The value of the attribute.
returned: when present
type: str
description: The container instance attributes required by your task
returned: when present
type: complex
revision:
description: Revision number that was queried
returned: always
type: int
status:
description: The status of the task definition
returned: always
type: str
task_definition_arn:
description: ARN of the task definition
returned: always
type: str
task_role_arn:
description: The ARN of the IAM role that containers in this task can assume
returned: when role is set
type: str
volumes:
contains:
host:
description: 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
type: bool
name:
description: The name of the volume.
returned: when present
type: str
source_path:
description: The path on the host container instance that is presented to the
container.
returned: when present
type: str
description: The list of volumes in a task
returned: always
type: complex