amazon.aws.backup_plan module – Manage AWS Backup Plans
Note
This module is part of the amazon.aws collection (version 8.2.1).
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 amazon.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.backup_plan.
New in amazon.aws 6.0.0
Synopsis
Creates, updates, or deletes AWS Backup Plans.
For more information see the AWS documentation for Backup plans https://docs.aws.amazon.com/aws-backup/latest/devguide/about-backup-plans.html.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Specifies a list of advanced backup settings for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs. |
|
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs. |
|
Enable or disable WindowsVSS backup option. Choices:
|
|
Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). Choices:
|
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
The display name of a backup plan. Must contain 1 to 50 alphanumeric or ‘-_.’ characters. |
|
Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. Required when |
|
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. AWS default if not supplied is Default: |
|
An array of copy_action objects, which contains the details of the copy operation. |
|
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. |
|
Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. |
|
Specifies the number of days after creation that a recovery point is deleted. Must be greater than |
|
Specifies the number of days after creation that a recovery point is moved to cold storage. |
|
Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups. AWS default if not supplied is Choices:
|
|
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. |
|
Specifies the number of days after creation that a recovery point is deleted. Must be greater than |
|
Specifies the number of days after creation that a recovery point is moved to cold storage. |
|
To help organize your resources, you can assign your own metadata to the resources that you create. |
|
Name of the rule. |
|
A CRON expression in UTC specifying when Backup initiates a backup job. AWS default is used if not supplied. Default: |
|
This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone. This option requires botocore >= 1.31.36. Default: |
|
A value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully. If this value is included, it must be at least 60 minutes to avoid errors. AWS default if not supplied is Default: |
|
Name of the Backup Vault this rule should target. |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Create/update or delete a backup plan. Choices:
|
|
To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: Create an AWSbackup plan
amazon.aws.backup_plan:
state: present
backup_plan_name: elastic
rules:
- rule_name: daily
advanced_backup_settings:
- resource_type: "EC2"
backup_options:
WindowsVSS: enabled
target_backup_vault_name: "{{ backup_vault_name }}"
schedule_expression: 'cron(0 5 ? * * *)'
start_window_minutes: 60
completion_window_minutes: 1440
- name: Delete an AWS Backup plan
amazon.aws.backup_plan:
backup_plan_name: elastic
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Backup plan details. Returned: on create/update |
|
Advanced backup settings of the backup plan. Returned: when configured. Sample: |
|
Backup options of the advanced settings. Returned: success Sample: |
|
Resource type of the advanced settings. Returned: success Sample: |
|
The display name of a backup plan. Returned: always Sample: |
|
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources. Returned: always |
|
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. Returned: always Sample: |
|
An array of CopyAction objects, which contains the details of the copy operation. Returned: when configured. Sample: |
|
Specifies whether Backup creates continuous backups. Returned: always Sample: |
|
Defines when a protected resource is transitioned to cold storage and when it expires. Returned: when configured. Sample: |
|
An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup. Returned: when configured. Sample: |
|
Uniquely identifies a rule that is used to schedule the backup of a selection of resources. Returned: always Sample: |
|
A display name for a backup rule. Returned: always Sample: |
|
A cron expression in UTC specifying when Backup initiates a backup job. Returned: always Sample: |
|
This is the timezone in which the schedule expression is set. This information is returned for botocore versions >= 1.31.36. Returned: when botocore >= 1.31.36 Sample: |
|
A value in minutes after a backup is scheduled before a job will be canceled if it doesn’t start successfully. Returned: always Sample: |
|
The name of a logical container where backups are stored. Returned: always Sample: |
|
Tags of the backup plan. Returned: on create/update Sample: |
|
ARN of the backup plan. Returned: always Sample: |
|
ID of the backup plan. Returned: always Sample: |
|
Name of the backup plan. Returned: always Sample: |
|
Creation date of the backup plan. Returned: on create/update Sample: |
|
Date the backup plan was deleted. Returned: on delete Sample: |
|
Whether the resource exists. Returned: always Sample: |
|
Version ID of the backup plan. Returned: always Sample: |