community / community.aws / 5.1.0 / module / autoscaling_lifecycle_hook Create, delete or update AWS ASG Lifecycle Hooks | "added in version" 1.0.0 of community.aws" Authors: Igor 'Tsigankov' Eyrich (@tsiganenok) <tsiganenok@gmail.com>community.aws.autoscaling_lifecycle_hook (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Will create a new hook when I(state=present) and no given Hook is found.
Will update an existing hook when I(state=present) and a Hook is found, but current and provided parameters differ.
Will delete the hook when I(state=absent) and a Hook is found.
Prior to release 5.0.0 this module was called C(community.aws.ec2_asg_lifecycle_hook). The usage did not change.
- name: Create / Update lifecycle hook community.aws.autoscaling_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
- name: Delete lifecycle hook community.aws.autoscaling_lifecycle_hook: region: eu-central-1 state: absent autoscaling_group_name: example lifecycle_hook_name: example
state: choices: - present - absent default: present description: - Create or delete Lifecycle Hook. - When I(state=present) updates existing hook or creates a new hook if not found. type: str 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 role_arn: description: - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. 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 transition: choices: - autoscaling:EC2_INSTANCE_TERMINATING - autoscaling:EC2_INSTANCE_LAUNCHING description: - The instance state to which you want to attach the lifecycle hook. - Required when I(state=present). 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 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. 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 heartbeat_timeout: 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. - By default Amazon AWS will use C(3600) (1 hour). type: int lifecycle_hook_name: description: - The name of the lifecycle hook. required: true type: str autoscaling_group_name: description: - The name of the Auto Scaling group to which you want to assign the lifecycle hook. required: true type: str notification_meta_data: description: - Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. type: str 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. 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
auto_scaling_group_name: description: The unique name of the auto scaling group. returned: success sample: myasg type: str default_result: description: Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. returned: success sample: CONTINUE type: str global_timeout: description: The maximum time, in seconds, that an instance can remain in a C(Pending:Wait) or C(Terminating:Wait) state. returned: success sample: 172800 type: int heartbeat_timeout: description: The maximum time, in seconds, that can elapse before the lifecycle hook times out. returned: success sample: 3600 type: int lifecycle_hook_name: description: The name of the lifecycle hook. returned: success sample: mylifecyclehook type: str lifecycle_transition: description: The instance state to which lifecycle hook should be attached. returned: success sample: autoscaling:EC2_INSTANCE_LAUNCHING type: str