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

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to.

Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument.

Will be marked changed when called only if there are ELBs found to operate on.

Requirements

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

Inputs

    
wait:
    default: 'yes'
    description:
    - Wait for instance registration or deregistration to complete successfully before
      returning.
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - register or deregister the instance
    required: true

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

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

ec2_elbs:
    description:
    - List of ELB names, required for registration. The ec2_elbs fact should be used if
      there was a previous de-register.

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

instance_id:
    description:
    - EC2 Instance ID
    required: true

wait_timeout:
    default: 0
    description:
    - Number of seconds to wait for an instance to change state. If 0 then this module
      may return an error if a transient error occurs. If non-zero then any transient
      errors are ignored until the timeout is reached. Ignored when wait=no.
    version_added: '1.6'
    version_added_collection: ansible.builtin

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: 'yes'
    description:
    - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
    type: bool
    version_added: '1.5'
    version_added_collection: ansible.builtin

enable_availability_zone:
    default: 'yes'
    description:
    - Whether to enable the availability zone of the instance on the target ELB if the
      availability zone has not already been enabled. If set to no, the task will fail
      if the availability zone is not enabled on the ELB.
    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