community / community.aws / 4.3.0 / module / ec2_asg_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.ec2_asg_lifecycle_hook (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.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.
- name: Create / Update lifecycle hook community.aws.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
- name: Delete lifecycle hook community.aws.ec2_asg_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. 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: - Uses a boto profile. Only works with boto >= 2.24.0. - 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. type: str 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 when I(state=present). type: str aws_ca_bundle: description: - 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.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - 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 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: - 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 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. type: str security_token: aliases: - aws_security_token - access_token description: - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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 boto versions >= 2.6.0. 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 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: '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
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 Pending:Wait or 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