community.aws.ec2_asg_scheduled_action module – Create, modify and delete ASG scheduled scaling actions.
Note
This module is part of the community.aws collection (version 3.6.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.ec2_asg_scheduled_action
.
New in community.aws 2.2.0
Synopsis
The module will create a new scheduled action when state=present and no given action is found.
The module will update a new scheduled action when state=present and the given action is found.
The module will delete a new scheduled action when state=absent and the given action is found.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
The name of the autoscaling group to add a scheduled action to. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. Choices:
|
|
ASG desired capacity. |
|
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. |
|
End time for the action. |
|
ASG max capacity. |
|
ASG min capacity. |
|
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. |
|
Cron style schedule to repeat the action on. Required when state=present. |
|
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 |
|
The name of the scheduled action. |
|
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_session_token and session_token have been added in version 3.2.0. |
|
Start time for the action. |
|
Create / update or delete scheduled action. Choices:
|
|
Time zone to run against. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
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
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Create a scheduled action for a autoscaling group.
- name: Create a minimal scheduled action for autoscaling group
community.aws.ec2_asg_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
start_time: 2021 October 25 08:00 UTC
recurrence: 40 22 * * 1-5
desired_capacity: 10
state: present
register: scheduled_action
- name: Create a scheduled action for autoscaling group
community.aws.ec2_asg_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
start_time: 2021 October 25 08:00 UTC
end_time: 2021 October 25 08:00 UTC
time_zone: Europe/London
recurrence: 40 22 * * 1-5
min_size: 10
max_size: 15
desired_capacity: 10
state: present
register: scheduled_action
- name: Delete scheduled action
community.aws.ec2_asg_scheduled_action:
region: eu-west-1
autoscaling_group_name: test_asg
scheduled_action_name: test_scheduled_action
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
ASG desired capacity. Returned: when state=present Sample: |
|
End time for the action. Returned: when state=present Sample: |
|
ASG max capacity. Returned: when state=present Sample: |
|
ASG min capacity. Returned: when state=present Sample: |
|
Cron style schedule to repeat the action on. Returned: when state=present Sample: |
|
The name of the scheduled action. Returned: when state=present Sample: |
|
Start time for the action. Returned: when state=present Sample: |
|
The ID of the Amazon Machine Image used by the launch configuration. Returned: when state=present Sample: |