Skip to content

Latest commit

 

History

History
770 lines (727 loc) · 33.9 KB

community.missing_collection.aws_ecs_info_module.rst

File metadata and controls

770 lines (727 loc) · 33.9 KB

community.missing_collection.aws_ecs_info

Get Information about Amazon EC2 Container Service (ECS).

Version added: 0.0.6

Synopsis

Requirements

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
arn
string
arn of ecs cluster.
arns
list
can be list of arn of tasks?
can be list of arn of container instances?
can be list of arn of ecs clusters?
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
container_instance_status
string
    Choices:
  • ACTIVE ←
  • DRAINING
  • REGISTERING
  • DEREGISTERING
  • REGISTRATION_FAILED
container instance status.
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.
describe_clusters
boolean
    Choices:
  • no
  • yes
do you want to get details of clusters for given cluster arns?
describe_container_instances
boolean
    Choices:
  • no
  • yes
do you want to get details of container instances for given container instance arns?
describe_services
boolean
    Choices:
  • no
  • yes
do you want to get details of services for given cluster arn and service names?
describe_task_definition
boolean
    Choices:
  • no
  • yes
do you want to get details of task definition for given task arn?
describe_tasks
boolean
    Choices:
  • no
  • yes
do you want to get details of tasks for given cluster arn and tasks arns?
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
launch_type
string
    Choices:
  • EC2 ←
  • FARGATE
type of launch.
list_container_instances
boolean
    Choices:
  • no
  • yes
do you want to get list of container instances for given cluster arn and container_instance_status?
list_services
boolean
    Choices:
  • no
  • yes
do you want to get list of services for given cluster arn and launch_type?
list_task_definitions
boolean
    Choices:
  • no
  • yes
do you want to get list of task definitions for given task_definition_status?
list_tasks
boolean
    Choices:
  • no
  • yes
do you want to get list of tasks for given cluster arn, launch_type and task_desired_status?
names
list
list of name of ecs services.
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_status
string
    Choices:
  • ACTIVE ←
  • INACTIVE
task definition status.
task_desired_status
string
    Choices:
  • RUNNING ←
  • PENDING
  • STOPPED
task desired status.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes

Note

  • 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

- name: "get list of cluster arns."
  aws_ecs_info:
  register: _reg

- name: "get list of container instance arns"
  aws_ecs_info:
    list_container_instances: true
    arn: '{{ _reg.cluster_arns[0] }}'
    container_instance_status: 'ACTIVE'

- name: "get list of service arns"
  aws_ecs_info:
    list_services: true
    arn: '{{ _reg.cluster_arns[0] }}'
    launch_type: 'EC2'

- name: "get list of task definition arns"
  aws_ecs_info:
    list_task_definitions: true
    task_definition_status: 'ACTIVE'

- name: "get list of task arns"
  aws_ecs_info:
    list_tasks: true
    arn: '{{ _reg.cluster_arns[0] }}'
    launch_type: 'EC2'
    task_desired_status: 'RUNNING'

- name: "get details of clusters"
  aws_ecs_info:
    describe_clusters: true
    arns: ['test-arn']

- name: "get details of container instances"
  aws_ecs_info:
    describe_container_instances: true
    arns: ['test-container-instance-arn']

- name: "get details of service"
  aws_ecs_info:
    describe_services: true
    arn: '{{ _reg.cluster_arns[0] }}'
    names: ['test-service-name']

- name: "get details of task definition"
  aws_ecs_info:
    describe_task_definition: true
    arn: '{{ _reg.cluster_arns[0] }}'
    arns: ['test-task-definition-arn']

- name: "get details of task"
  aws_ecs_info:
    describe_tasks: true
    arn: '{{ _reg.cluster_arns[0] }}'
    arns: ['test-task-arn']

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
cluster_arns
list
when no arguments are defined and success
list of cluster arns.
clusters
list
when `describe_clusters` is defined and success
details about clusters.
container_instance_arns
list
when `list_container_instances` is defined and success
list of container instance arns
container_instances
list
when `describe_container_instances` is defined and success
details about container instances.
service_arns
list
when `list_services` is defined and success
list of service arns.
services
list
when `describe_services` is defined and success
details about services.
task_arns
list
when `list_tasks` is defined and success
list of task arns.
task_definition
dictionary
when `describe_task_definition` is defined and success
details about task definitions.
task_definition_arns
list
when `list_task_definitions` is defined and success
list of task definition arns.
tasks
list
when `describe_tasks` is defined and success
details about tasks.


Status

Authors