Class Snapshot
- java.lang.Object
-
- com.amazonaws.services.ec2.model.Snapshot
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Snapshot extends Object implements Serializable, Cloneable
Describes a snapshot.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Snapshot()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Snapshot
clone()
boolean
equals(Object obj)
String
getDataEncryptionKeyId()
The data encryption key identifier for the snapshot.String
getDescription()
The description for the snapshot.Boolean
getEncrypted()
Indicates whether the snapshot is encrypted.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.String
getOwnerAlias()
The AWS account alias (for example,amazon
,self
) or AWS account ID that owns the snapshot.String
getOwnerId()
The AWS account ID of the EBS snapshot owner.String
getProgress()
The progress of the snapshot, as a percentage.String
getSnapshotId()
The ID of the snapshot.Date
getStartTime()
The time stamp when the snapshot was initiated.String
getState()
The snapshot state.String
getStateMessage()
Encrypted Amazon EBS snapshots are copied asynchronously.List<Tag>
getTags()
Any tags assigned to the snapshot.String
getVolumeId()
The ID of the volume that was used to create the snapshot.Integer
getVolumeSize()
The size of the volume, in GiB.int
hashCode()
Boolean
isEncrypted()
Indicates whether the snapshot is encrypted.void
setDataEncryptionKeyId(String dataEncryptionKeyId)
The data encryption key identifier for the snapshot.void
setDescription(String description)
The description for the snapshot.void
setEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.void
setKmsKeyId(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(String ownerAlias)
The AWS account alias (for example,amazon
,self
) or AWS account ID that owns the snapshot.void
setOwnerId(String ownerId)
The AWS account ID of the EBS snapshot owner.void
setProgress(String progress)
The progress of the snapshot, as a percentage.void
setSnapshotId(String snapshotId)
The ID of the snapshot.void
setStartTime(Date startTime)
The time stamp when the snapshot was initiated.void
setState(SnapshotState state)
The snapshot state.void
setState(String state)
The snapshot state.void
setStateMessage(String stateMessage)
Encrypted Amazon EBS snapshots are copied asynchronously.void
setTags(Collection<Tag> tags)
Any tags assigned to the snapshot.void
setVolumeId(String volumeId)
The ID of the volume that was used to create the snapshot.void
setVolumeSize(Integer volumeSize)
The size of the volume, in GiB.String
toString()
Returns a string representation of this object; useful for testing and debugging.Snapshot
withDataEncryptionKeyId(String dataEncryptionKeyId)
The data encryption key identifier for the snapshot.Snapshot
withDescription(String description)
The description for the snapshot.Snapshot
withEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.Snapshot
withKmsKeyId(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(String ownerAlias)
The AWS account alias (for example,amazon
,self
) or AWS account ID that owns the snapshot.Snapshot
withOwnerId(String ownerId)
The AWS account ID of the EBS snapshot owner.Snapshot
withProgress(String progress)
The progress of the snapshot, as a percentage.Snapshot
withSnapshotId(String snapshotId)
The ID of the snapshot.Snapshot
withStartTime(Date startTime)
The time stamp when the snapshot was initiated.Snapshot
withState(SnapshotState state)
The snapshot state.Snapshot
withState(String state)
The snapshot state.Snapshot
withStateMessage(String stateMessage)
Encrypted Amazon EBS snapshots are copied asynchronously.Snapshot
withTags(Tag... tags)
Any tags assigned to the snapshot.Snapshot
withTags(Collection<Tag> tags)
Any tags assigned to the snapshot.Snapshot
withVolumeId(String volumeId)
The ID of the volume that was used to create the snapshot.Snapshot
withVolumeSize(Integer volumeSize)
The size of the volume, in GiB.
-
-
-
Method Detail
-
setSnapshotId
public void setSnapshotId(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.
-
getSnapshotId
public 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.
-
withSnapshotId
public Snapshot withSnapshotId(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVolumeId
public void setVolumeId(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.
-
getVolumeId
public 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.
-
withVolumeId
public Snapshot withVolumeId(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setState
public void setState(String state)
The snapshot state.
- Parameters:
state
- The snapshot state.- See Also:
SnapshotState
-
getState
public String getState()
The snapshot state.
- Returns:
- The snapshot state.
- See Also:
SnapshotState
-
withState
public Snapshot withState(String state)
The snapshot state.
- Parameters:
state
- The snapshot state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SnapshotState
-
setState
public void setState(SnapshotState state)
The snapshot state.
- Parameters:
state
- The snapshot state.- See Also:
SnapshotState
-
withState
public Snapshot withState(SnapshotState state)
The snapshot state.
- Parameters:
state
- The snapshot state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SnapshotState
-
setStateMessage
public void setStateMessage(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.
-
getStateMessage
public 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.
-
withStateMessage
public Snapshot withStateMessage(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartTime
public void setStartTime(Date startTime)
The time stamp when the snapshot was initiated.
- Parameters:
startTime
- The time stamp when the snapshot was initiated.
-
getStartTime
public Date getStartTime()
The time stamp when the snapshot was initiated.
- Returns:
- The time stamp when the snapshot was initiated.
-
withStartTime
public Snapshot withStartTime(Date startTime)
The time stamp when the snapshot was initiated.
- Parameters:
startTime
- The time stamp when the snapshot was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProgress
public void setProgress(String progress)
The progress of the snapshot, as a percentage.
- Parameters:
progress
- The progress of the snapshot, as a percentage.
-
getProgress
public String getProgress()
The progress of the snapshot, as a percentage.
- Returns:
- The progress of the snapshot, as a percentage.
-
withProgress
public Snapshot withProgress(String progress)
The progress of the snapshot, as a percentage.
- Parameters:
progress
- The progress of the snapshot, as a percentage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOwnerId
public void setOwnerId(String ownerId)
The AWS account ID of the EBS snapshot owner.
- Parameters:
ownerId
- The AWS account ID of the EBS snapshot owner.
-
getOwnerId
public String getOwnerId()
The AWS account ID of the EBS snapshot owner.
- Returns:
- The AWS account ID of the EBS snapshot owner.
-
withOwnerId
public Snapshot withOwnerId(String ownerId)
The AWS account ID of the EBS snapshot owner.
- Parameters:
ownerId
- The AWS account ID of the EBS snapshot owner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
The description for the snapshot.
- Parameters:
description
- The description for the snapshot.
-
getDescription
public String getDescription()
The description for the snapshot.
- Returns:
- The description for the snapshot.
-
withDescription
public Snapshot withDescription(String description)
The description for the snapshot.
- Parameters:
description
- The description for the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVolumeSize
public void setVolumeSize(Integer volumeSize)
The size of the volume, in GiB.
- Parameters:
volumeSize
- The size of the volume, in GiB.
-
getVolumeSize
public Integer getVolumeSize()
The size of the volume, in GiB.
- Returns:
- The size of the volume, in GiB.
-
withVolumeSize
public Snapshot withVolumeSize(Integer volumeSize)
The size of the volume, in GiB.
- Parameters:
volumeSize
- The size of the volume, in GiB.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOwnerAlias
public void setOwnerAlias(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.
-
getOwnerAlias
public 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.
-
withOwnerAlias
public Snapshot withOwnerAlias(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
Any tags assigned to the snapshot.
- Returns:
- Any tags assigned to the snapshot.
-
setTags
public void setTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- Any tags assigned to the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public Snapshot withTags(Collection<Tag> tags)
Any tags assigned to the snapshot.
- Parameters:
tags
- Any tags assigned to the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEncrypted
public void setEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
- Parameters:
encrypted
- Indicates whether the snapshot is encrypted.
-
getEncrypted
public Boolean getEncrypted()
Indicates whether the snapshot is encrypted.
- Returns:
- Indicates whether the snapshot is encrypted.
-
withEncrypted
public Snapshot withEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
- Parameters:
encrypted
- Indicates whether the snapshot is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEncrypted
public Boolean isEncrypted()
Indicates whether the snapshot is encrypted.
- Returns:
- Indicates whether the snapshot is encrypted.
-
setKmsKeyId
public void setKmsKeyId(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.
-
getKmsKeyId
public 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.
-
withKmsKeyId
public Snapshot withKmsKeyId(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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDataEncryptionKeyId
public void setDataEncryptionKeyId(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.
-
getDataEncryptionKeyId
public 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.
-
withDataEncryptionKeyId
public Snapshot withDataEncryptionKeyId(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.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-