community / community.aws / 4.3.0 / module / ec2_asg_scheduled_action Create, modify and delete ASG scheduled scaling actions. | "added in version" 2.2.0 of community.aws" Authors: Mark Woolley(@marknet15)community.aws.ec2_asg_scheduled_action (4.3.0) — module
Install with ansible-galaxy collection install community.aws:==4.3.0
collections: - name: community.aws version: 4.3.0
The module will create a new scheduled action when I(state=present) and no given action is found.
The module will update a new scheduled action when I(state=present) and the given action is found.
The module will delete a new scheduled action when I(state=absent) and the given action is found.
# 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
state: choices: - present - absent default: present description: - Create / update or delete scheduled action. required: false 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 end_time: description: - End time for the action. type: str max_size: description: - ASG max capacity. type: int min_size: description: - ASG min capacity. type: int time_zone: description: - Time zone to run against. 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 recurrence: description: - Cron style schedule to repeat the action on. - Required when I(state=present). type: str start_time: description: - Start time for the action. 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 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 desired_capacity: description: - ASG desired capacity. type: int scheduled_action_name: description: - The name of the scheduled action. required: true type: str autoscaling_group_name: description: - The name of the autoscaling group to add a scheduled action to. required: true 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
desired_capacity: description: ASG desired capacity. returned: when I(state=present) sample: 1 type: int end_time: description: End time for the action. returned: when I(state=present) sample: 2021 October 25 08:00 UTC type: str max_size: description: ASG max capacity. returned: when I(state=present) sample: 2 type: int min_size: description: ASG min capacity. returned: when I(state=present) sample: 1 type: int recurrence: description: Cron style schedule to repeat the action on. returned: when I(state=present) sample: 40 22 * * 1-5 type: str scheduled_action_name: description: The name of the scheduled action. returned: when I(state=present) sample: test_scheduled_action type: str start_time: description: Start time for the action. returned: when I(state=present) sample: 2021 October 25 08:00 UTC type: str time_zone: description: The ID of the Amazon Machine Image used by the launch configuration. returned: when I(state=present) sample: Europe/London type: str