community.aws.ec2_asg_lifecycle_hook – Create, delete or update AWS ASG Lifecycle Hooks.¶
Note
This plugin is part of the community.aws collection (version 1.4.0).
To install it use: ansible-galaxy collection install community.aws
.
To use it in a playbook, specify: community.aws.ec2_asg_lifecycle_hook
.
New in version 1.0.0: of community.aws
Synopsis¶
Will create a new hook when state=present and no given Hook is found.
Will update an existing hook when state=present and a Hook is found, but current and provided parameters differ.
Will delete the hook when state=absent and a Hook is found.
Requirements¶
The below requirements are needed on the host that executes this module.
boto
boto3>=1.4.4
python >= 2.6
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
autoscaling_group_name
string
/ required
|
The name of the Auto Scaling group to which you want to assign the lifecycle hook.
|
|
aws_access_key
string
|
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 profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
|
aws_ca_bundle
path
|
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.
|
|
aws_config
dictionary
|
A dictionary to modify the botocore configuration.
Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
|
aws_secret_key
string
|
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 profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
|
debug_botocore_endpoint_logs
boolean
|
|
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.
|
default_result
string
|
|
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
|
ec2_url
string
|
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.
aliases: aws_endpoint_url, endpoint_url |
|
heartbeat_timeout
integer
|
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)
|
|
lifecycle_hook_name
string
/ required
|
The name of the lifecycle hook.
|
|
notification_meta_data
string
|
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
|
|
notification_target_arn
string
|
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.
|
|
profile
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
|
region
string
|
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region |
|
role_arn
string
|
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
|
|
security_token
string
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
|
state
string
|
|
Create or delete Lifecycle Hook.
When state=present updates existing hook or creates a new hook if not found.
|
transition
string
|
|
The instance state to which you want to attach the lifecycle hook.
Required when state=present.
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Notes¶
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file
Examples¶
- 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
Authors¶
Igor ‘Tsigankov’ Eyrich (@tsiganenok) <tsiganenok@gmail.com>