@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Snapshot extends Object implements Serializable, Cloneable
Describes a snapshot.
Constructor and Description |
---|
Snapshot() |
Modifier and Type | Method and 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 Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent
volume.
|
String |
getOutpostArn()
The ARN of the Outpost on which the snapshot is stored.
|
String |
getOwnerAlias()
The Amazon Web Services owner alias, from an Amazon-maintained list (
amazon ). |
String |
getOwnerId()
The ID of the Amazon Web Services account that owns the EBS snapshot.
|
String |
getProgress()
The progress of the snapshot, as a percentage.
|
Date |
getRestoreExpiryTime()
Only for archived snapshots that are temporarily restored.
|
String |
getSnapshotId()
The ID of the snapshot.
|
String |
getSseType()
Reserved for future use.
|
Date |
getStartTime()
The time stamp when the snapshot was initiated.
|
String |
getState()
The snapshot state.
|
String |
getStateMessage()
Encrypted Amazon EBS snapshots are copied asynchronously.
|
String |
getStorageTier()
The storage tier in which the snapshot is stored.
|
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 Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent
volume.
|
void |
setOutpostArn(String outpostArn)
The ARN of the Outpost on which the snapshot is stored.
|
void |
setOwnerAlias(String ownerAlias)
The Amazon Web Services owner alias, from an Amazon-maintained list (
amazon ). |
void |
setOwnerId(String ownerId)
The ID of the Amazon Web Services account that owns the EBS snapshot.
|
void |
setProgress(String progress)
The progress of the snapshot, as a percentage.
|
void |
setRestoreExpiryTime(Date restoreExpiryTime)
Only for archived snapshots that are temporarily restored.
|
void |
setSnapshotId(String snapshotId)
The ID of the snapshot.
|
void |
setSseType(SSEType sseType)
Reserved for future use.
|
void |
setSseType(String sseType)
Reserved for future use.
|
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 |
setStorageTier(StorageTier storageTier)
The storage tier in which the snapshot is stored.
|
void |
setStorageTier(String storageTier)
The storage tier in which the snapshot is stored.
|
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.
|
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 Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent
volume.
|
Snapshot |
withOutpostArn(String outpostArn)
The ARN of the Outpost on which the snapshot is stored.
|
Snapshot |
withOwnerAlias(String ownerAlias)
The Amazon Web Services owner alias, from an Amazon-maintained list (
amazon ). |
Snapshot |
withOwnerId(String ownerId)
The ID of the Amazon Web Services account that owns the EBS snapshot.
|
Snapshot |
withProgress(String progress)
The progress of the snapshot, as a percentage.
|
Snapshot |
withRestoreExpiryTime(Date restoreExpiryTime)
Only for archived snapshots that are temporarily restored.
|
Snapshot |
withSnapshotId(String snapshotId)
The ID of the snapshot.
|
Snapshot |
withSseType(SSEType sseType)
Reserved for future use.
|
Snapshot |
withSseType(String sseType)
Reserved for future use.
|
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 |
withStorageTier(StorageTier storageTier)
The storage tier in which the snapshot is stored.
|
Snapshot |
withStorageTier(String storageTier)
The storage tier in which the snapshot is stored.
|
Snapshot |
withTags(Collection<Tag> tags)
Any tags assigned to the snapshot.
|
Snapshot |
withTags(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.
|
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 DescribeSnapshots.
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 DescribeSnapshots.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 DescribeSnapshots.
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 DescribeSnapshots.
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 DescribeSnapshots.public void setDescription(String description)
The description for the snapshot.
description
- The description for the snapshot.public String getDescription()
The description for the snapshot.
public Snapshot withDescription(String description)
The description for the snapshot.
description
- The description for the snapshot.public void setEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
encrypted
- Indicates whether the snapshot is encrypted.public Boolean getEncrypted()
Indicates whether the snapshot is encrypted.
public Snapshot withEncrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
encrypted
- Indicates whether the snapshot is encrypted.public Boolean isEncrypted()
Indicates whether the snapshot is encrypted.
public void setKmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
kmsKeyId
- The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the
parent volume.public String getKmsKeyId()
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
public Snapshot withKmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the parent volume.
kmsKeyId
- The Amazon Resource Name (ARN) of the KMS key that was used to protect the volume encryption key for the
parent volume.public void setOwnerId(String ownerId)
The ID of the Amazon Web Services account that owns the EBS snapshot.
ownerId
- The ID of the Amazon Web Services account that owns the EBS snapshot.public String getOwnerId()
The ID of the Amazon Web Services account that owns the EBS snapshot.
public Snapshot withOwnerId(String ownerId)
The ID of the Amazon Web Services account that owns the EBS snapshot.
ownerId
- The ID of the Amazon Web Services account that owns the EBS snapshot.public void setProgress(String progress)
The progress of the snapshot, as a percentage.
progress
- The progress of the snapshot, as a percentage.public String getProgress()
The progress of the snapshot, as a percentage.
public Snapshot withProgress(String progress)
The progress of the snapshot, as a percentage.
progress
- The progress of the snapshot, as a percentage.public void setSnapshotId(String snapshotId)
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
snapshotId
- The ID of the snapshot. Each snapshot receives a unique identifier when it is created.public String getSnapshotId()
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
public Snapshot withSnapshotId(String snapshotId)
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
snapshotId
- The ID of the snapshot. Each snapshot receives a unique identifier when it is created.public void setStartTime(Date startTime)
The time stamp when the snapshot was initiated.
startTime
- The time stamp when the snapshot was initiated.public Date getStartTime()
The time stamp when the snapshot was initiated.
public Snapshot withStartTime(Date startTime)
The time stamp when the snapshot was initiated.
startTime
- The time stamp when the snapshot was initiated.public void setState(String state)
The snapshot state.
state
- The snapshot state.SnapshotState
public String getState()
The snapshot state.
SnapshotState
public Snapshot withState(String state)
The snapshot state.
state
- The snapshot state.SnapshotState
public void setState(SnapshotState state)
The snapshot state.
state
- The snapshot state.SnapshotState
public Snapshot withState(SnapshotState state)
The snapshot state.
state
- The snapshot state.SnapshotState
public void setStateMessage(String stateMessage)
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper 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 DescribeSnapshots.
stateMessage
- Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example,
if the proper 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 DescribeSnapshots.public String getStateMessage()
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper 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 DescribeSnapshots.
public Snapshot withStateMessage(String stateMessage)
Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper 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 DescribeSnapshots.
stateMessage
- Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example,
if the proper 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 DescribeSnapshots.public void setVolumeId(String volumeId)
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
volumeId
- The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot
action have an arbitrary volume ID that should not be used for any purpose.public String getVolumeId()
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
public Snapshot withVolumeId(String volumeId)
The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
volumeId
- The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot
action have an arbitrary volume ID that should not be used for any purpose.public void setVolumeSize(Integer volumeSize)
The size of the volume, in GiB.
volumeSize
- The size of the volume, in GiB.public Integer getVolumeSize()
The size of the volume, in GiB.
public Snapshot withVolumeSize(Integer volumeSize)
The size of the volume, in GiB.
volumeSize
- The size of the volume, in GiB.public void setOwnerAlias(String ownerAlias)
The Amazon Web Services owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured Amazon Web Services account alias set using the IAM console.
ownerAlias
- The Amazon Web Services owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured Amazon Web Services account alias set using the IAM console.public String getOwnerAlias()
The Amazon Web Services owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured Amazon Web Services account alias set using the IAM console.
amazon
). This is not
the user-configured Amazon Web Services account alias set using the IAM console.public Snapshot withOwnerAlias(String ownerAlias)
The Amazon Web Services owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured Amazon Web Services account alias set using the IAM console.
ownerAlias
- The Amazon Web Services owner alias, from an Amazon-maintained list (amazon
). This is not the
user-configured Amazon Web Services account alias set using the IAM console.public void setOutpostArn(String outpostArn)
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
outpostArn
- The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots
on Outposts in the Amazon EBS User Guide.public String getOutpostArn()
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
public Snapshot withOutpostArn(String outpostArn)
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
outpostArn
- The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots
on Outposts in the Amazon EBS User Guide.public List<Tag> getTags()
Any tags assigned to the snapshot.
public void setTags(Collection<Tag> tags)
Any tags assigned to the snapshot.
tags
- Any tags assigned to the snapshot.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)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Any tags assigned to the snapshot.public Snapshot withTags(Collection<Tag> tags)
Any tags assigned to the snapshot.
tags
- Any tags assigned to the snapshot.public void setStorageTier(String storageTier)
The storage tier in which the snapshot is stored. standard
indicates that the snapshot is stored in
the standard snapshot storage tier and that it is ready for use. archive
indicates that the snapshot
is currently archived and that it must be restored before it can be used.
storageTier
- The storage tier in which the snapshot is stored. standard
indicates that the snapshot is
stored in the standard snapshot storage tier and that it is ready for use. archive
indicates
that the snapshot is currently archived and that it must be restored before it can be used.StorageTier
public String getStorageTier()
The storage tier in which the snapshot is stored. standard
indicates that the snapshot is stored in
the standard snapshot storage tier and that it is ready for use. archive
indicates that the snapshot
is currently archived and that it must be restored before it can be used.
standard
indicates that the snapshot is
stored in the standard snapshot storage tier and that it is ready for use. archive
indicates
that the snapshot is currently archived and that it must be restored before it can be used.StorageTier
public Snapshot withStorageTier(String storageTier)
The storage tier in which the snapshot is stored. standard
indicates that the snapshot is stored in
the standard snapshot storage tier and that it is ready for use. archive
indicates that the snapshot
is currently archived and that it must be restored before it can be used.
storageTier
- The storage tier in which the snapshot is stored. standard
indicates that the snapshot is
stored in the standard snapshot storage tier and that it is ready for use. archive
indicates
that the snapshot is currently archived and that it must be restored before it can be used.StorageTier
public void setStorageTier(StorageTier storageTier)
The storage tier in which the snapshot is stored. standard
indicates that the snapshot is stored in
the standard snapshot storage tier and that it is ready for use. archive
indicates that the snapshot
is currently archived and that it must be restored before it can be used.
storageTier
- The storage tier in which the snapshot is stored. standard
indicates that the snapshot is
stored in the standard snapshot storage tier and that it is ready for use. archive
indicates
that the snapshot is currently archived and that it must be restored before it can be used.StorageTier
public Snapshot withStorageTier(StorageTier storageTier)
The storage tier in which the snapshot is stored. standard
indicates that the snapshot is stored in
the standard snapshot storage tier and that it is ready for use. archive
indicates that the snapshot
is currently archived and that it must be restored before it can be used.
storageTier
- The storage tier in which the snapshot is stored. standard
indicates that the snapshot is
stored in the standard snapshot storage tier and that it is ready for use. archive
indicates
that the snapshot is currently archived and that it must be restored before it can be used.StorageTier
public void setRestoreExpiryTime(Date restoreExpiryTime)
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
restoreExpiryTime
- Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily
restored snapshot will be automatically re-archived.public Date getRestoreExpiryTime()
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
public Snapshot withRestoreExpiryTime(Date restoreExpiryTime)
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
restoreExpiryTime
- Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily
restored snapshot will be automatically re-archived.public void setSseType(String sseType)
Reserved for future use.
sseType
- Reserved for future use.SSEType
public String getSseType()
Reserved for future use.
SSEType
public Snapshot withSseType(String sseType)
Reserved for future use.
sseType
- Reserved for future use.SSEType
public void setSseType(SSEType sseType)
Reserved for future use.
sseType
- Reserved for future use.SSEType
public Snapshot withSseType(SSEType sseType)
Reserved for future use.
sseType
- Reserved for future use.SSEType
public String toString()
toString
in class Object
Object.toString()