volume_recovery_points

Creates, updates, deletes, gets or lists a volume_recovery_points resource.

Overview

Name	volume_recovery_points
Type	Resource
Id	aws.storagegateway.volume_recovery_points

Fields

The following fields are returned by SELECT queries:

list_volume_recovery_points

Name	Datatype	Description
gateway_arn	string	The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
volume_recovery_point_infos	array	An array of VolumeRecoveryPointInfo objects.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_volume_recovery_points	select	region		Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.
create_snapshot_from_volume_recovery_point	insert	region, VolumeARN, SnapshotDescription		Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_volume_recovery_points

Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type. Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

SELECT
gateway_arn,
volume_recovery_point_infos
FROM aws.storagegateway.volume_recovery_points
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_snapshot_from_volume_recovery_point

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints. In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

INSERT INTO aws.storagegateway.volume_recovery_points (
VolumeARN,
SnapshotDescription,
Tags,
region
)
SELECT 
'{{ VolumeARN }}' /* required */,
'{{ SnapshotDescription }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
snapshot_id,
volume_arn,
volume_recovery_point_time
;

Manifest

# Description fields are for documentation purposes
- name: volume_recovery_points
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the volume_recovery_points resource.
  - name: VolumeARN
    value: "{{ VolumeARN }}"
    description: |
      The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
  - name: SnapshotDescription
    value: "{{ SnapshotDescription }}"
    description: |
      Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
  - name: Tags
    description: |
      A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"