com.amazonaws.services.storagegateway.model
Class CreateSnapshotRequest

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

public class CreateSnapshotRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateSnapshot operation.

This operation initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.

In the CreateSnapshot request you identify the volume by providing it's Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears 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 the Amazon Elastic Compute Cloud API Reference.

See Also:

AWSStorageGateway.createSnapshot(CreateSnapshotRequest)

Constructor Summary

CreateSnapshotRequest()

Method Summary

boolean	equals(Object obj)
String	getSnapshotDescription() Textual description of the snapshot that appears in the AWS Storage Gateway Console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
String	getVolumeARN() The Amazon Resource Name (ARN) of the volume.
int	hashCode()
void	setSnapshotDescription(String snapshotDescription) Textual description of the snapshot that appears in the AWS Storage Gateway Console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
void	setVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSnapshotRequest	withSnapshotDescription(String snapshotDescription) Textual description of the snapshot that appears in the AWS Storage Gateway Console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field.
CreateSnapshotRequest	withVolumeARN(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

CreateSnapshotRequest

public CreateSnapshotRequest()

Method Detail

getVolumeARN

public 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(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 CreateSnapshotRequest withVolumeARN(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 String getSnapshotDescription()

Textual description of the snapshot that appears in the AWS Storage Gateway 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:

Textual description of the snapshot that appears in the AWS Storage Gateway 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(String snapshotDescription)

Textual description of the snapshot that appears in the AWS Storage Gateway 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 - Textual description of the snapshot that appears in the AWS Storage Gateway 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 CreateSnapshotRequest withSnapshotDescription(String snapshotDescription)

Textual description of the snapshot that appears in the AWS Storage Gateway 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 - Textual description of the snapshot that appears in the AWS Storage Gateway 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 String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object