public static interface Snapshot.Builder extends CopyableBuilder<Snapshot.Builder,Snapshot>
Modifier and Type | Method and Description |
---|---|
Snapshot.Builder |
dataEncryptionKeyId(String dataEncryptionKeyId)
The data encryption key identifier for the snapshot.
|
Snapshot.Builder |
description(String description)
The description for the snapshot.
|
Snapshot.Builder |
encrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
|
Snapshot.Builder |
kmsKeyId(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.Builder |
ownerAlias(String ownerAlias)
Value from an Amazon-maintained list (
amazon | aws-marketplace |
microsoft ) of snapshot owners. |
Snapshot.Builder |
ownerId(String ownerId)
The AWS account ID of the EBS snapshot owner.
|
Snapshot.Builder |
progress(String progress)
The progress of the snapshot, as a percentage.
|
Snapshot.Builder |
snapshotId(String snapshotId)
The ID of the snapshot.
|
Snapshot.Builder |
startTime(Instant startTime)
The time stamp when the snapshot was initiated.
|
Snapshot.Builder |
state(SnapshotState state)
The snapshot state.
|
Snapshot.Builder |
state(String state)
The snapshot state.
|
Snapshot.Builder |
stateMessage(String stateMessage)
Encrypted Amazon EBS snapshots are copied asynchronously.
|
Snapshot.Builder |
tags(Collection<Tag> tags)
Any tags assigned to the snapshot.
|
Snapshot.Builder |
tags(Tag... tags)
Any tags assigned to the snapshot.
|
Snapshot.Builder |
volumeId(String volumeId)
The ID of the volume that was used to create the snapshot.
|
Snapshot.Builder |
volumeSize(Integer volumeSize)
The size of the volume, in GiB.
|
copy
apply, build
Snapshot.Builder dataEncryptionKeyId(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.
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.Snapshot.Builder description(String description)
The description for the snapshot.
description
- The description for the snapshot.Snapshot.Builder encrypted(Boolean encrypted)
Indicates whether the snapshot is encrypted.
encrypted
- Indicates whether the snapshot is encrypted.Snapshot.Builder kmsKeyId(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.
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.Builder ownerId(String ownerId)
The AWS account ID of the EBS snapshot owner.
ownerId
- The AWS account ID of the EBS snapshot owner.Snapshot.Builder progress(String progress)
The progress of the snapshot, as a percentage.
progress
- The progress of the snapshot, as a percentage.Snapshot.Builder snapshotId(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.Snapshot.Builder startTime(Instant startTime)
The time stamp when the snapshot was initiated.
startTime
- The time stamp when the snapshot was initiated.Snapshot.Builder state(String state)
The snapshot state.
state
- The snapshot state.SnapshotState
,
SnapshotState
Snapshot.Builder state(SnapshotState state)
The snapshot state.
state
- The snapshot state.SnapshotState
,
SnapshotState
Snapshot.Builder stateMessage(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.
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.Snapshot.Builder volumeId(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.Snapshot.Builder volumeSize(Integer volumeSize)
The size of the volume, in GiB.
volumeSize
- The size of the volume, in GiB.Snapshot.Builder ownerAlias(String ownerAlias)
Value from an Amazon-maintained list (amazon
| aws-marketplace
|
microsoft
) of snapshot owners. Not to be confused with the user-configured AWS account alias,
which is set from the IAM console.
ownerAlias
- Value from an Amazon-maintained list (amazon
| aws-marketplace
|
microsoft
) of snapshot owners. Not to be confused with the user-configured AWS account
alias, which is set from the IAM console.Snapshot.Builder tags(Collection<Tag> tags)
Any tags assigned to the snapshot.
tags
- Any tags assigned to the snapshot.Snapshot.Builder tags(Tag... tags)
Any tags assigned to the snapshot.
tags
- Any tags assigned to the snapshot.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.