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

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

When no given Hook found, will create one.

In case Hook found, but provided parameters are differes, will update existing Hook.

In case state=absent and Hook exists, will delete it.

Requirements

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

Usage examples

Scanned by Steampunk Spotter

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

# Create / Update lifecycle hook
- ec2_asg_lifecycle_hook:
    region: eu-central-1
    state: present
    autoscaling_group_name: example
    lifecycle_hook_name: example
    transition: autoscaling:EC2_INSTANCE_LAUNCHING
    heartbeat_timeout: 7000
    default_result: ABANDON

Scanned by Steampunk Spotter

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

# Delete lifecycle hook
- ec2_asg_lifecycle_hook:
    region: eu-central-1
    state: absent
    autoscaling_group_name: example
    lifecycle_hook_name: example

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Create or delete Lifecycle Hook. Present updates existing one or creates if not
      found.
    required: false

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

role_arn:
    description:
    - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified
      notification target.
    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

transition:
    choices:
    - autoscaling:EC2_INSTANCE_TERMINATING
    - autoscaling:EC2_INSTANCE_LAUNCHING
    description:
    - The instance state to which you want to attach the lifecycle hook.
    required: true

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

default_result:
    choices:
    - ABANDON
    - CONTINUE
    default: ABANDON
    description:
    - Defines the action the Auto Scaling group should take when the lifecycle hook timeout
      elapses or if an unexpected failure occurs. This parameter can be either CONTINUE
      or ABANDON.
    required: false

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

heartbeat_timeout:
    default: 3600 (1 hour)
    description:
    - The amount of time, in seconds, that can elapse before the lifecycle hook times
      out. When the lifecycle hook times out, Auto Scaling performs the default action.
      You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    required: false

lifecycle_hook_name:
    description:
    - The name of the lifecycle hook.
    required: true

autoscaling_group_name:
    description:
    - The name of the Auto Scaling group to which you want to assign the lifecycle hook.
    required: true

notification_meta_data:
    description:
    - Contains additional information that you want to include any time Auto Scaling sends
      a message to the notification target.
    required: false

notification_target_arn:
    description:
    - The ARN of the notification target that Auto Scaling will use to notify you when
      an instance is in the transition state for the lifecycle hook. This target can be
      either an SQS queue or an SNS topic. If you specify an empty string, this overrides
      the current ARN.
    required: false

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