amazon.aws.backup_selection module – Create, delete and modify AWS Backup selection

Note

This module is part of the amazon.aws collection (version 7.2.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 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

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

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

backup_plan_name

aliases: plan_name

string / required

Uniquely identifies the backup plan to be associated with the selection of resources.

backup_selection_name

aliases: selection_name

string / required

The display name of a resource selection document. Must contain 1 to 50 alphanumeric or ‘-_.’ characters.

conditions

dictionary

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).

conditions supports string_equals, string_like, string_not_equals, and string_not_like. list_of_tags only supports string_equals.

string_equals

list / elements=dictionary

Filters the values of your tagged resources for only those resources that you tagged with the same value.

Default: []

condition_key

string

The key in a key-value pair.

condition_key in the conditions option must use the AWS resource tag prefix, e.g. ‘aws:ResourceTag/key-name’

condition_value

string

The value in a key-value pair.

string_like

list / elements=dictionary

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: []

condition_key

string

The key in a key-value pair.

condition_key in the conditions option must use the AWS resource tag prefix, e.g. ‘aws:ResourceTag/key-name’

condition_value

string

The value in a key-value pair.

string_not_equals

list / elements=dictionary

Filters the values of your tagged resources for only those resources that you tagged that do not have the same value.

Default: []

condition_key

string

The key in a key-value pair.

condition_key in the conditions option must use the AWS resource tag prefix, e.g. ‘aws:ResourceTag/key-name’

condition_value

string

The value in a key-value pair.

string_not_like

list / elements=dictionary

Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

Default: []

condition_key

string

The key in a key-value pair.

condition_key in the conditions option must use the AWS resource tag prefix, e.g. ‘aws:ResourceTag/key-name’

condition_value

string

The value in a key-value pair.

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.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

iam_role_arn

string

The ARN of the IAM role that Backup uses to authenticate when backing up the target resource.

list_of_tags

list / elements=dictionary

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 list_of_tags, you assign all resources that match AT LEAST ONE condition (using OR logic).

condition_key

string

The key in a key-value pair.

condition_type

string

An operation applied to a key-value pair used to assign resources to your backup plan.

Condition only supports STRINGEQUALS.

condition_value

string

The value in a key-value pair.

not_resources

list / elements=string

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.

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

resources

list / elements=string

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.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

state

string

Create, delete a backup selection.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

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: 1111f877-1ecf-4d79-9718-a861cd09df3b
    iam_role_arn: arn:aws:iam::111122223333:role/system-backup
    resources:
      - arn:aws:elasticfilesystem:*:*:file-system/*

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

backup_selection

complex

Backup selection details.

Returned: always

backup_plan_id

string

Backup plan id.

Returned: always

Sample: "1111f877-1ecf-4d79-9718-a861cd09df3b"

conditions

dictionary

List of conditions (expressed as a dict) that are defined to assign resources to the backup plan using tags.

Returned: always

Sample: {}

creation_date

string

Backup plan creation date.

Returned: always

Sample: "2023-01-24T10:08:03.193000+01:00"

iam_role_arn

string

The ARN of the IAM role that Backup uses.

Returned: always

Sample: "arn:aws:iam::111122223333:role/system-backup"

list_of_tags

list / elements=dictionary

Conditions defined to assign resources to the backup plans using tags.

Returned: always

Sample: []

not_resources

list / elements=string

List of Amazon Resource Names (ARNs) that are excluded from the backup plan.

Returned: always

Sample: []

resources

list / elements=string

List of Amazon Resource Names (ARNs) that are assigned to the backup plan.

Returned: always

Sample: []

selection_id

string

Backup selection id.

Returned: always

Sample: "1111c217-5d71-4a55-8728-5fc4e63d437b"

selection_name

string

Backup selection name.

Returned: always

Sample: "elastic"

Authors

  • Kristof Imre Szabo (@krisek)

  • Alina Buzachis (@alinabuzachis)