Class Snapshot
- All Implemented Interfaces:
Serializable
,Cloneable
Describes a snapshot.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The data encryption key identifier for the snapshot.The description for the snapshot.Indicates whether the snapshot is encrypted.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.The AWS account alias (for example,amazon
,self
) or AWS account ID that owns the snapshot.The AWS account ID of the EBS snapshot owner.The progress of the snapshot, as a percentage.The ID of the snapshot.The time stamp when the snapshot was initiated.getState()
The snapshot state.Encrypted Amazon EBS snapshots are copied asynchronously.getTags()
Any tags assigned to the snapshot.The ID of the volume that was used to create the snapshot.The size of the volume, in GiB.int
hashCode()
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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withDataEncryptionKeyId
(String dataEncryptionKeyId) The data encryption key identifier for the snapshot.withDescription
(String description) The description for the snapshot.withEncrypted
(Boolean encrypted) Indicates whether the snapshot is encrypted.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.withOwnerAlias
(String ownerAlias) The AWS account alias (for example,amazon
,self
) or AWS account ID that owns the snapshot.withOwnerId
(String ownerId) The AWS account ID of the EBS snapshot owner.withProgress
(String progress) The progress of the snapshot, as a percentage.withSnapshotId
(String snapshotId) The ID of the snapshot.withStartTime
(Date startTime) The time stamp when the snapshot was initiated.withState
(SnapshotState state) The snapshot state.The snapshot state.withStateMessage
(String stateMessage) Encrypted Amazon EBS snapshots are copied asynchronously.Any tags assigned to the snapshot.withTags
(Collection<Tag> tags) Any tags assigned to the snapshot.withVolumeId
(String volumeId) The ID of the volume that was used to create the snapshot.withVolumeSize
(Integer volumeSize) The size of the volume, in GiB.
-
Constructor Details
-
Snapshot
public Snapshot()
-
-
Method Details
-
setSnapshotId
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
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
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
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
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
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
The snapshot state.
- Parameters:
state
- The snapshot state.- See Also:
-
getState
The snapshot state.
- Returns:
- The snapshot state.
- See Also:
-
withState
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:
-
setState
The snapshot state.
- Parameters:
state
- The snapshot state.- See Also:
-
withState
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:
-
setStateMessage
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
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
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
The time stamp when the snapshot was initiated.
- Parameters:
startTime
- The time stamp when the snapshot was initiated.
-
getStartTime
The time stamp when the snapshot was initiated.
- Returns:
- The time stamp when the snapshot was initiated.
-
withStartTime
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
The progress of the snapshot, as a percentage.
- Parameters:
progress
- The progress of the snapshot, as a percentage.
-
getProgress
The progress of the snapshot, as a percentage.
- Returns:
- The progress of the snapshot, as a percentage.
-
withProgress
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
The AWS account ID of the EBS snapshot owner.
- Parameters:
ownerId
- The AWS account ID of the EBS snapshot owner.
-
getOwnerId
The AWS account ID of the EBS snapshot owner.
- Returns:
- The AWS account ID of the EBS snapshot owner.
-
withOwnerId
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
The description for the snapshot.
- Parameters:
description
- The description for the snapshot.
-
getDescription
The description for the snapshot.
- Returns:
- The description for the snapshot.
-
withDescription
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
The size of the volume, in GiB.
- Parameters:
volumeSize
- The size of the volume, in GiB.
-
getVolumeSize
The size of the volume, in GiB.
- Returns:
- The size of the volume, in GiB.
-
withVolumeSize
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
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
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
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
Any tags assigned to the snapshot.
- Returns:
- Any tags assigned to the snapshot.
-
setTags
Any tags assigned to the snapshot.
- Parameters:
tags
- Any tags assigned to the snapshot.
-
withTags
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
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
Indicates whether the snapshot is encrypted.
- Parameters:
encrypted
- Indicates whether the snapshot is encrypted.
-
getEncrypted
Indicates whether the snapshot is encrypted.
- Returns:
- Indicates whether the snapshot is encrypted.
-
withEncrypted
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
Indicates whether the snapshot is encrypted.
- Returns:
- Indicates whether the snapshot is encrypted.
-
setKmsKeyId
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-