|
Did this page help you?Yes No Tell us about it... |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.storagegateway.model.CreateSnapshotRequest
public class CreateSnapshotRequest
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 its 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.
AWSStorageGateway.createSnapshot(CreateSnapshotRequest)
,
Serialized FormConstructor Summary | |
---|---|
CreateSnapshotRequest()
|
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
String |
getSnapshotDescription()
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 |
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 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(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 Amazon EC2 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 |
---|
public CreateSnapshotRequest()
Method Detail |
---|
public String getVolumeARN()
Constraints:
Length: 50 - 500
public void setVolumeARN(String volumeARN)
Constraints:
Length: 50 - 500
volumeARN
- The Amazon Resource Name (ARN) of the volume. Use the
ListVolumes operation to return a list of gateway volumes.public CreateSnapshotRequest withVolumeARN(String volumeARN)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 50 - 500
volumeARN
- The Amazon Resource Name (ARN) of the volume. Use the
ListVolumes operation to return a list of gateway volumes.
public String getSnapshotDescription()
Constraints:
Length: 1 - 255
public void setSnapshotDescription(String snapshotDescription)
Constraints:
Length: 1 - 255
snapshotDescription
- 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 fieldpublic CreateSnapshotRequest withSnapshotDescription(String snapshotDescription)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
snapshotDescription
- 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
public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |