com.amazonaws.services.ec2.model

Class CreateSnapshotRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateSnapshotRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateSnapshotRequest>, Serializable

public class CreateSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<CreateSnapshotRequest>

Container for the parameters to the CreateSnapshot operation.

Create a snapshot of the volume identified by volume ID. A volume does not have to be detached at the time the snapshot is taken.

NOTE: Snapshot creation requires that the system is in a consistent state. For instance, this means that if taking a snapshot of a database, the tables must be read-only locked to ensure that the snapshot will not contain a corrupted version of the database. Therefore, be careful when using this API to ensure that the system remains in the consistent state until the create snapshot status has returned.

See Also:

AmazonEC2.createSnapshot(CreateSnapshotRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotRequest() Default constructor for a new CreateSnapshotRequest object.
CreateSnapshotRequest(String volumeId, String description) Constructs a new CreateSnapshotRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() The description for the new snapshot.
Request<CreateSnapshotRequest>	getDryRunRequest() This method is intended for internal use only.
String	getVolumeId() The ID of the volume from which to create the snapshot.
int	hashCode()
void	setDescription(String description) The description for the new snapshot.
void	setVolumeId(String volumeId) The ID of the volume from which to create the snapshot.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateSnapshotRequest	withDescription(String description) The description for the new snapshot.
CreateSnapshotRequest	withVolumeId(String volumeId) The ID of the volume from which to create the snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSnapshotRequest

public CreateSnapshotRequest()

Default constructor for a new CreateSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

CreateSnapshotRequest

public CreateSnapshotRequest(String volumeId,
                     String description)

Constructs a new CreateSnapshotRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

volumeId - The ID of the volume from which to create the snapshot.

description - The description for the new snapshot.

Method Detail

getVolumeId

public String getVolumeId()

The ID of the volume from which to create the snapshot.

Returns:

The ID of the volume from which to create the snapshot.

setVolumeId

public void setVolumeId(String volumeId)

The ID of the volume from which to create the snapshot.

Parameters:

volumeId - The ID of the volume from which to create the snapshot.

withVolumeId

public CreateSnapshotRequest withVolumeId(String volumeId)

The ID of the volume from which to create the snapshot.

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

Parameters:

volumeId - The ID of the volume from which to create the snapshot.

Returns:

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

getDescription

public String getDescription()

The description for the new snapshot.

Returns:

The description for the new snapshot.

setDescription

public void setDescription(String description)

The description for the new snapshot.

Parameters:

description - The description for the new snapshot.

withDescription

public CreateSnapshotRequest withDescription(String description)

The description for the new snapshot.

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

Parameters:

description - The description for the new snapshot.

Returns:

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

getDryRunRequest

public Request<CreateSnapshotRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateSnapshotRequest>

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