com.amazonaws.services.storagegateway.model
Class CreateSnapshotFromVolumeRecoveryPointRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.storagegateway.model.CreateSnapshotFromVolumeRecoveryPointRequest

public class CreateSnapshotFromVolumeRecoveryPointRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateSnapshotFromVolumeRecoveryPoint operation.

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see StorageGatewayConcepts).

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 gateway-cached volumes, 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 AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage 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.

NOTE: To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DeleteSnapshot and DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

See Also:

AWSStorageGateway.createSnapshotFromVolumeRecoveryPoint(CreateSnapshotFromVolumeRecoveryPointRequest)

Constructor Summary

CreateSnapshotFromVolumeRecoveryPointRequest()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getSnapshotDescription() A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
java.lang.String	getVolumeARN() The Amazon Resource Name (ARN) of the volume.
int	hashCode()
void	setSnapshotDescription(java.lang.String snapshotDescription) A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
void	setVolumeARN(java.lang.String volumeARN) The Amazon Resource Name (ARN) of the volume.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSnapshotFromVolumeRecoveryPointRequest	withSnapshotDescription(java.lang.String snapshotDescription) A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
CreateSnapshotFromVolumeRecoveryPointRequest	withVolumeARN(java.lang.String volumeARN) The Amazon Resource Name (ARN) of the volume.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSnapshotFromVolumeRecoveryPointRequest

public CreateSnapshotFromVolumeRecoveryPointRequest()

Method Detail

getVolumeARN

public java.lang.String getVolumeARN()

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

setVolumeARN

public void setVolumeARN(java.lang.String volumeARN)

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Constraints:
Length: 50 - 500

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

withVolumeARN

public CreateSnapshotFromVolumeRecoveryPointRequest withVolumeARN(java.lang.String volumeARN)

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 50 - 500

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnapshotDescription

public java.lang.String getSnapshotDescription()

A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

Constraints:
Length: 1 - 255

Returns:

A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

setSnapshotDescription

public void setSnapshotDescription(java.lang.String snapshotDescription)

A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

Constraints:
Length: 1 - 255

Parameters:

snapshotDescription - A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

withSnapshotDescription

public CreateSnapshotFromVolumeRecoveryPointRequest withSnapshotDescription(java.lang.String snapshotDescription)

A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

snapshotDescription - A textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.

Length: Minimum length of 1. Maximum length of 255.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object