com.amazonaws.services.ec2.model

Class Snapshot

java.lang.Object

com.amazonaws.services.ec2.model.Snapshot

All Implemented Interfaces:

java.io.Serializable

public class Snapshot
extends java.lang.Object
implements java.io.Serializable

Describes a snapshot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Snapshot()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDataEncryptionKeyId() The data encryption key identifier for the snapshot.
java.lang.String	getDescription() The description for the snapshot.
java.lang.Boolean	getEncrypted() Indicates whether the snapshot is encrypted.
java.lang.String	getKmsKeyId() The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
java.lang.String	getOwnerAlias() The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
java.lang.String	getOwnerId() The AWS account ID of the EBS snapshot owner.
java.lang.String	getProgress() The progress of the snapshot, as a percentage.
java.lang.String	getSnapshotId() The ID of the snapshot.
java.util.Date	getStartTime() The time stamp when the snapshot was initiated.
java.lang.String	getState() The snapshot state.
java.lang.String	getStateMessage() Encrypted Amazon EBS snapshots are copied asynchronously.
java.util.List<Tag>	getTags() Any tags assigned to the snapshot.
java.lang.String	getVolumeId() The ID of the volume that was used to create the snapshot.
java.lang.Integer	getVolumeSize() The size of the volume, in GiB.
int	hashCode()
java.lang.Boolean	isEncrypted() Indicates whether the snapshot is encrypted.
void	setDataEncryptionKeyId(java.lang.String dataEncryptionKeyId) The data encryption key identifier for the snapshot.
void	setDescription(java.lang.String description) The description for the snapshot.
void	setEncrypted(java.lang.Boolean encrypted) Indicates whether the snapshot is encrypted.
void	setKmsKeyId(java.lang.String kmsKeyId) The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
void	setOwnerAlias(java.lang.String ownerAlias) The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
void	setOwnerId(java.lang.String ownerId) The AWS account ID of the EBS snapshot owner.
void	setProgress(java.lang.String progress) The progress of the snapshot, as a percentage.
void	setSnapshotId(java.lang.String snapshotId) The ID of the snapshot.
void	setStartTime(java.util.Date startTime) The time stamp when the snapshot was initiated.
void	setState(SnapshotState state) The snapshot state.
void	setState(java.lang.String state) The snapshot state.
void	setStateMessage(java.lang.String stateMessage) Encrypted Amazon EBS snapshots are copied asynchronously.
void	setTags(java.util.Collection<Tag> tags) Any tags assigned to the snapshot.
void	setVolumeId(java.lang.String volumeId) The ID of the volume that was used to create the snapshot.
void	setVolumeSize(java.lang.Integer volumeSize) The size of the volume, in GiB.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Snapshot	withDataEncryptionKeyId(java.lang.String dataEncryptionKeyId) The data encryption key identifier for the snapshot.
Snapshot	withDescription(java.lang.String description) The description for the snapshot.
Snapshot	withEncrypted(java.lang.Boolean encrypted) Indicates whether the snapshot is encrypted.
Snapshot	withKmsKeyId(java.lang.String kmsKeyId) The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.
Snapshot	withOwnerAlias(java.lang.String ownerAlias) The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
Snapshot	withOwnerId(java.lang.String ownerId) The AWS account ID of the EBS snapshot owner.
Snapshot	withProgress(java.lang.String progress) The progress of the snapshot, as a percentage.
Snapshot	withSnapshotId(java.lang.String snapshotId) The ID of the snapshot.
Snapshot	withStartTime(java.util.Date startTime) The time stamp when the snapshot was initiated.
Snapshot	withState(SnapshotState state) The snapshot state.
Snapshot	withState(java.lang.String state) The snapshot state.
Snapshot	withStateMessage(java.lang.String stateMessage) Encrypted Amazon EBS snapshots are copied asynchronously.
Snapshot	withTags(java.util.Collection<Tag> tags) Any tags assigned to the snapshot.
Snapshot	withTags(Tag... tags) Any tags assigned to the snapshot.
Snapshot	withVolumeId(java.lang.String volumeId) The ID of the volume that was used to create the snapshot.
Snapshot	withVolumeSize(java.lang.Integer volumeSize) The size of the volume, in GiB.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Snapshot

public Snapshot()

Method Detail

getSnapshotId

public java.lang.String getSnapshotId()

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Returns:

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

setSnapshotId

public void setSnapshotId(java.lang.String snapshotId)

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Parameters:

snapshotId - The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

withSnapshotId

public Snapshot withSnapshotId(java.lang.String snapshotId)

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

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

Parameters:

snapshotId - The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

Returns:

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

getVolumeId

public java.lang.String getVolumeId()

The ID of the volume that was used to create the snapshot.

Returns:

The ID of the volume that was used to create the snapshot.

setVolumeId

public void setVolumeId(java.lang.String volumeId)

The ID of the volume that was used to create the snapshot.

Parameters:

volumeId - The ID of the volume that was used to create the snapshot.

withVolumeId

public Snapshot withVolumeId(java.lang.String volumeId)

The ID of the volume that was used 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 that was used to create the snapshot.

Returns:

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

getState

public java.lang.String getState()

The snapshot state.

Constraints:
Allowed Values: pending, completed, error

Returns:

The snapshot state.

See Also:

SnapshotState

setState

public void setState(java.lang.String state)

The snapshot state.

Constraints:
Allowed Values: pending, completed, error

Parameters:

state - The snapshot state.

See Also:

SnapshotState

withState

public Snapshot withState(java.lang.String state)

The snapshot state.

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

Constraints:
Allowed Values: pending, completed, error

Parameters:

state - The snapshot state.

Returns:

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

See Also:

SnapshotState

setState

public void setState(SnapshotState state)

The snapshot state.

Constraints:
Allowed Values: pending, completed, error

Parameters:

state - The snapshot state.

See Also:

SnapshotState

withState

public Snapshot withState(SnapshotState state)

The snapshot state.

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

Constraints:
Allowed Values: pending, completed, error

Parameters:

state - The snapshot state.

Returns:

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

See Also:

SnapshotState

getStateMessage

public java.lang.String getStateMessage()

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

Returns:

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

setStateMessage

public void setStateMessage(java.lang.String stateMessage)

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

Parameters:

stateMessage - Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

withStateMessage

public Snapshot withStateMessage(java.lang.String stateMessage)

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

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

Parameters:

stateMessage - Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

Returns:

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

getStartTime

public java.util.Date getStartTime()

The time stamp when the snapshot was initiated.

Returns:

The time stamp when the snapshot was initiated.

setStartTime

public void setStartTime(java.util.Date startTime)

The time stamp when the snapshot was initiated.

Parameters:

startTime - The time stamp when the snapshot was initiated.

withStartTime

public Snapshot withStartTime(java.util.Date startTime)

The time stamp when the snapshot was initiated.

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

Parameters:

startTime - The time stamp when the snapshot was initiated.

Returns:

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

getProgress

public java.lang.String getProgress()

The progress of the snapshot, as a percentage.

Returns:

The progress of the snapshot, as a percentage.

setProgress

public void setProgress(java.lang.String progress)

The progress of the snapshot, as a percentage.

Parameters:

progress - The progress of the snapshot, as a percentage.

withProgress

public Snapshot withProgress(java.lang.String progress)

The progress of the snapshot, as a percentage.

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

Parameters:

progress - The progress of the snapshot, as a percentage.

Returns:

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

getOwnerId

public java.lang.String getOwnerId()

The AWS account ID of the EBS snapshot owner.

Returns:

The AWS account ID of the EBS snapshot owner.

setOwnerId

public void setOwnerId(java.lang.String ownerId)

The AWS account ID of the EBS snapshot owner.

Parameters:

ownerId - The AWS account ID of the EBS snapshot owner.

withOwnerId

public Snapshot withOwnerId(java.lang.String ownerId)

The AWS account ID of the EBS snapshot owner.

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

Parameters:

ownerId - The AWS account ID of the EBS snapshot owner.

Returns:

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

getDescription

public java.lang.String getDescription()

The description for the snapshot.

Returns:

The description for the snapshot.

setDescription

public void setDescription(java.lang.String description)

The description for the snapshot.

Parameters:

description - The description for the snapshot.

withDescription

public Snapshot withDescription(java.lang.String description)

The description for the snapshot.

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

Parameters:

description - The description for the snapshot.

Returns:

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

getVolumeSize

public java.lang.Integer getVolumeSize()

The size of the volume, in GiB.

Returns:

The size of the volume, in GiB.

setVolumeSize

public void setVolumeSize(java.lang.Integer volumeSize)

The size of the volume, in GiB.

Parameters:

volumeSize - The size of the volume, in GiB.

withVolumeSize

public Snapshot withVolumeSize(java.lang.Integer volumeSize)

The size of the volume, in GiB.

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

Parameters:

volumeSize - The size of the volume, in GiB.

Returns:

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

getOwnerAlias

public java.lang.String getOwnerAlias()

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

Returns:

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

setOwnerAlias

public void setOwnerAlias(java.lang.String ownerAlias)

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

Parameters:

ownerAlias - The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

withOwnerAlias

public Snapshot withOwnerAlias(java.lang.String ownerAlias)

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

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

Parameters:

ownerAlias - The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

Returns:

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

getTags

public java.util.List<Tag> getTags()

Any tags assigned to the snapshot.

Returns:

Any tags assigned to the snapshot.

setTags

public void setTags(java.util.Collection<Tag> tags)

Any tags assigned to the snapshot.

Parameters:

tags - Any tags assigned to the snapshot.

withTags

public Snapshot withTags(Tag... tags)

Any tags assigned to the snapshot.

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

Parameters:

tags - Any tags assigned to the snapshot.

Returns:

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

withTags

public Snapshot withTags(java.util.Collection<Tag> tags)

Any tags assigned to the snapshot.

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

Parameters:

tags - Any tags assigned to the snapshot.

Returns:

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

isEncrypted

public java.lang.Boolean isEncrypted()

Indicates whether the snapshot is encrypted.

Returns:

Indicates whether the snapshot is encrypted.

setEncrypted

public void setEncrypted(java.lang.Boolean encrypted)

Indicates whether the snapshot is encrypted.

Parameters:

encrypted - Indicates whether the snapshot is encrypted.

withEncrypted

public Snapshot withEncrypted(java.lang.Boolean encrypted)

Indicates whether the snapshot is encrypted.

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

Parameters:

encrypted - Indicates whether the snapshot is encrypted.

Returns:

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

getEncrypted

public java.lang.Boolean getEncrypted()

Indicates whether the snapshot is encrypted.

Returns:

Indicates whether the snapshot is encrypted.

getKmsKeyId

public java.lang.String getKmsKeyId()

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Returns:

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

setKmsKeyId

public void setKmsKeyId(java.lang.String kmsKeyId)

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Parameters:

kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

withKmsKeyId

public Snapshot withKmsKeyId(java.lang.String kmsKeyId)

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

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

Parameters:

kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

Returns:

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

getDataEncryptionKeyId

public java.lang.String getDataEncryptionKeyId()

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

Returns:

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

setDataEncryptionKeyId

public void setDataEncryptionKeyId(java.lang.String dataEncryptionKeyId)

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

Parameters:

dataEncryptionKeyId - The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

withDataEncryptionKeyId

public Snapshot withDataEncryptionKeyId(java.lang.String dataEncryptionKeyId)

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

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

Parameters:

dataEncryptionKeyId - The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

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