ec2_snapshot_facts – Gather facts about ec2 volume snapshots in AWS

From Get docs
Ansible/docs/2.8/modules/ec2 snapshot facts module


ec2_snapshot_facts – Gather facts about ec2 volume snapshots in AWS

New in version 2.1.


Synopsis

  • Gather facts about ec2 volume snapshots in AWS

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

aws_access_key

string

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.


aliases: ec2_access_key, access_key

aws_secret_key

string

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.


aliases: ec2_secret_key, secret_key

debug_botocore_endpoint_logs

boolean

added in 2.8

  • no

  • yes

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.

ec2_url

string

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.

filters

-

Default:

{}

A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html for possible filters. Filter names and values are case sensitive.

owner_ids

-

Default:

[]

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned.

profile

string

Uses a boto profile. Only works with boto >= 2.24.0.

region

string

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


aliases: aws_region, ec2_region

restorable_by_user_ids

-

Default:

[]

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned.

security_token

string

AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.


aliases: access_token

snapshot_ids

-

Default:

[]

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned.

validate_certs

boolean

  • no
  • yes

When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.



Notes

Note

  • By default, the module will return all snapshots, including public ones. To limit results to snapshots owned by the account use the filter ‘owner-id’.
  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file


Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather facts about all snapshots, including public ones
- ec2_snapshot_facts:

# Gather facts about all snapshots owned by the account 0123456789
- ec2_snapshot_facts:
    filters:
      owner-id: 0123456789

# Or alternatively...
- ec2_snapshot_facts:
    owner_ids:
      - 0123456789

# Gather facts about a particular snapshot using ID
- ec2_snapshot_facts:
    filters:
      snapshot-id: snap-00112233

# Or alternatively...
- ec2_snapshot_facts:
    snapshot_ids:
      - snap-00112233

# Gather facts about any snapshot with a tag key Name and value Example
- ec2_snapshot_facts:
    filters:
      "tag:Name": Example

# Gather facts about any snapshot with an error status
- ec2_snapshot_facts:
    filters:
      status: error

Return Values

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

Key Returned Description

data_encryption_key_id

string

always

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy.


Sample:

arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456

description

string

always

The description for the snapshot.


Sample:

My important backup

encrypted

boolean

always

Indicates whether the snapshot is encrypted.


Sample:

True

kms_key_id

string

always

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.


Sample:

74c9742a-a1b2-45cb-b3fe-abcdef123456

owner_alias

string

always

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.


Sample:

033440102211

owner_id

string

always

The AWS account ID of the EBS snapshot owner.


Sample:

099720109477

progress

string

always

The progress of the snapshot, as a percentage.


Sample:

100%

snapshot_id

string

always

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.


Sample:

snap-01234567

start_time

string

always

The time stamp when the snapshot was initiated.


Sample:

2015-02-12T02:14:02+00:00

state

string

always

The snapshot state (completed, pending or error).


Sample:

completed

state_message

string

always

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred.


tags

dictionary

always

Any tags assigned to the snapshot.


Sample:

{ 'my_tag_key': 'my_tag_value' }

volume_id

string

always

The ID of the volume that was used to create the snapshot.


Sample:

vol-01234567

volume_size

integer

always

The size of the volume, in GiB.


Sample:

8




Status

Authors

  • Rob White (@wimnat)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ec2_snapshot_facts_module.html