ansible.builtin._ecs_service_facts (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Lists or describes services in ecs.

This module was called C(ecs_service_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ecs_service_info) module no longer returns C(ansible_facts)!

Requirements

• boto3
• boto3 >= 1.15.0
• botocore
• botocore >= 1.18.0
• json
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

# Basic listing example
- ecs_service_info:
    cluster: test-cluster
    service: console-test-service
    details: true
  register: output

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Basic listing example
- ecs_service_info:
    cluster: test-cluster
  register: output

Inputs

    
events:
    default: 'true'
    description:
    - Whether to return ECS service events. Only has an effect if C(details) is true.
    required: false
    type: bool
    version_added: '2.6'
    version_added_collection: ansible.builtin

region:
    aliases:
    - aws_region
    - ec2_region
    description:
    - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
    type: str

cluster:
    default: default
    description:
    - The cluster ARNS in which to list the services.
    required: false

details:
    default: 'false'
    description:
    - Set this to true if you want detailed information about the services.
    required: false
    type: bool

ec2_url:
    aliases:
    - aws_endpoint_url
    - endpoint_url
    description:
    - 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.
    type: str

profile:
    aliases:
    - aws_profile
    description:
    - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
      and support for passing them at the same time as I(profile) has been deprecated.
    - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
      exclusive with I(profile) after 2022-06-01.
    type: str

service:
    description:
    - One or more services to get details for
    required: false

aws_config:
    description:
    - A dictionary to modify the botocore configuration.
    - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
    - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
      for more boto configuration.
    type: dict

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - Not used by boto 2 based modules.
    - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
      from the controller if not run locally.'
    type: path

aws_access_key:
    aliases:
    - ec2_access_key
    - access_key
    description:
    - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
      or C(EC2_ACCESS_KEY) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

aws_secret_key:
    aliases:
    - ec2_secret_key
    - secret_key
    description:
    - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
      or C(EC2_SECRET_KEY) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

security_token:
    aliases:
    - aws_security_token
    - access_token
    description:
    - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
      or C(EC2_SECURITY_TOKEN) environment variable is used.
    - If I(profile) is set this parameter is ignored.
    - Passing the I(security_token) and I(profile) options at the same time has been deprecated
      and the options will be made mutually exclusive after 2022-06-01.
    type: str

validate_certs:
    default: true
    description:
    - When set to "no", SSL certificates will not be validated for communication with
      the AWS APIs.
    type: bool

debug_botocore_endpoint_logs:
    default: 'no'
    description:
    - 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.
    type: bool

Outputs

services:
  contains:
    clusterArn:
      description: The Amazon Resource Name (ARN) of the of the cluster that hosts
        the service.
      returned: always
      type: str
    deployments:
      description: list of service deployments
      returned: always
      type: list of complex
    desiredCount:
      description: The desired number of instantiations of the task definition to
        keep running on the service.
      returned: always
      type: int
    events:
      description: list of service events
      returned: when events is true
      type: list of complex
    loadBalancers:
      contains:
        containerName:
          description: The name of the container to associate with the load balancer.
          returned: always
          type: str
        containerPort:
          description: The port on the container to associate with the load balancer.
          returned: always
          type: int
        loadBalancerName:
          description: the name
          returned: always
          type: str
      description: A list of load balancer objects
      returned: always
      type: complex
    pendingCount:
      description: The number of tasks in the cluster that are in the PENDING state.
      returned: always
      type: int
    runningCount:
      description: The number of tasks in the cluster that are in the RUNNING state.
      returned: always
      type: int
    serviceArn:
      description: The Amazon Resource Name (ARN) that identifies the service. The
        ARN contains the arn:aws:ecs namespace, followed by the region of the service,
        the AWS account ID of the service owner, the service namespace, and then the
        service name. For example, arn:aws:ecs:region :012345678910 :service/my-service
        .
      returned: always
      type: str
    serviceName:
      description: A user-generated string used to identify the service
      returned: always
      type: str
    status:
      description: The valid values are ACTIVE, DRAINING, or INACTIVE.
      returned: always
      type: str
    taskDefinition:
      description: The ARN of a task definition to use for tasks in the service.
      returned: always
      type: str
  description: When details is false, returns an array of service ARNs, otherwise
    an array of complex objects as described below.
  returned: success
  type: complex