amazon.aws.backup_selection module – Create, delete and modify AWS Backup selection
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_selection.
New in amazon.aws 6.0.0
Synopsis
Manages AWS Backup selections.
For more information see the AWS documentation for backup selections https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.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 |
|
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. |
|
Uniquely identifies the backup plan to be associated with the selection of resources. |
|
The display name of a resource selection document. Must contain 1 to 50 alphanumeric or ‘-_.’ characters. |
|
A list of conditions (expressed as a dict) that you define to assign resources to your backup plans using tags. When you specify more than one condition in conditions, you only assign the resources that match ALL conditions (using AND logic).
|
|
Filters the values of your tagged resources for only those resources that you tagged with the same value. Default: |
|
The key in a key-value pair.
|
|
The value in a key-value pair. |
|
Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, “prod*” or “*rod*” matches the tag value “production”. Default: |
|
The key in a key-value pair.
|
|
The value in a key-value pair. |
|
Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Default: |
|
The key in a key-value pair.
|
|
The value in a key-value pair. |
|
Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string. Default: |
|
The key in a key-value pair.
|
|
The value in a key-value pair. |
|
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 |
|
The ARN of the IAM role that Backup uses to authenticate when backing up the target resource. |
|
A list of conditions that you define to assign resources to your backup plans using tags. Condition operators are case sensitive. When you specify more than one condition in |
|
The key in a key-value pair. |
|
An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports |
|
The value in a key-value pair. |
|
A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags. |
|
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. |
|
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 |
|
A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags. |
|
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, delete a backup selection. Choices:
|
|
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 backup selection
amazon.aws.backup_selection:
selection_name: elastic
backup_plan_name: test-backup-plan
iam_role_arn: arn:aws:iam::111122223333:role/system-backup
resources:
- arn:aws:elasticfilesystem:*:*:file-system/*
- name: Create backup selection, assign resources using tags
amazon.aws.backup_selection:
selection_name: elastic
backup_plan_name: test-backup-plan
iam_role_arn: arn:aws:iam::111122223333:role/system-backup
list_of_tags:
- condition_type: STRINGEQUALS
condition_key: Owner
condition_value: Dev01
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Backup selection details. Returned: always |
|
ID of the backup plan. Returned: always Sample: |
|
A list of conditions that defines how resources are assigned to backup plans using tags. Returned: always Sample: |
|
Filters the values of tagged resources for only those resources that are tagged with the same value. Returned: always Sample: |
|
Filters the values of tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. Returned: always Sample: |
|
Filters the values of tagged resources for only those resources that are not tagged with the same value. Returned: always Sample: |
|
Filters the values of tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string. Returned: always Sample: |
|
Creation date of the backup plan. Returned: on create/update Sample: |
|
The ARN of the IAM role that Backup uses to authenticate when backing up the target resource. Returned: always Sample: |
|
Conditions defined to assign resources to the backup plans using tags. Returned: always Sample: |
|
The key in a key-value pair. Returned: always Sample: |
|
An operation applied to a key-value pair used to assign resources to backup plan. Returned: always Sample: |
|
The value in a key-value pair. Returned: always Sample: |
|
List of Amazon Resource Names (ARNs) that are excluded from the backup plan. Returned: always Sample: |
|
List of Amazon Resource Names (ARNs) that are assigned to the backup plan. Returned: always Sample: |
|
Backup selection id. Returned: always Sample: |
|
The display name of a resource selection document. Returned: always Sample: |