Interface Volume.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<Volume.Builder,Volume>
,SdkBuilder<Volume.Builder,Volume>
,SdkPojo
- Enclosing class:
- Volume
public static interface Volume.Builder extends SdkPojo, CopyableBuilder<Volume.Builder,Volume>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Volume.Builder
attachments(Collection<VolumeAttachment> attachments)
Information about the volume attachments.Volume.Builder
attachments(Consumer<VolumeAttachment.Builder>... attachments)
Information about the volume attachments.Volume.Builder
attachments(VolumeAttachment... attachments)
Information about the volume attachments.Volume.Builder
availabilityZone(String availabilityZone)
The Availability Zone for the volume.Volume.Builder
createTime(Instant createTime)
The time stamp when volume creation was initiated.Volume.Builder
encrypted(Boolean encrypted)
Indicates whether the volume is encrypted.Volume.Builder
fastRestored(Boolean fastRestored)
Indicates whether the volume was created using fast snapshot restore.Volume.Builder
iops(Integer iops)
The number of I/O operations per second (IOPS).Volume.Builder
kmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.Volume.Builder
multiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether Amazon EBS Multi-Attach is enabled.Volume.Builder
outpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.Volume.Builder
size(Integer size)
The size of the volume, in GiBs.Volume.Builder
snapshotId(String snapshotId)
The snapshot from which the volume was created, if applicable.Volume.Builder
sseType(String sseType)
Reserved for future use.Volume.Builder
sseType(SSEType sseType)
Reserved for future use.Volume.Builder
state(String state)
The volume state.Volume.Builder
state(VolumeState state)
The volume state.Volume.Builder
tags(Collection<Tag> tags)
Any tags assigned to the volume.Volume.Builder
tags(Consumer<Tag.Builder>... tags)
Any tags assigned to the volume.Volume.Builder
tags(Tag... tags)
Any tags assigned to the volume.Volume.Builder
throughput(Integer throughput)
The throughput that the volume supports, in MiB/s.Volume.Builder
volumeId(String volumeId)
The ID of the volume.Volume.Builder
volumeType(String volumeType)
The volume type.Volume.Builder
volumeType(VolumeType volumeType)
The volume type.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
attachments
Volume.Builder attachments(Collection<VolumeAttachment> attachments)
Information about the volume attachments.
- Parameters:
attachments
- Information about the volume attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
Volume.Builder attachments(VolumeAttachment... attachments)
Information about the volume attachments.
- Parameters:
attachments
- Information about the volume attachments.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
Volume.Builder attachments(Consumer<VolumeAttachment.Builder>... attachments)
Information about the volume attachments.
This is a convenience method that creates an instance of theVolumeAttachment.Builder
avoiding the need to create one manually viaVolumeAttachment.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#attachments(List
.) - Parameters:
attachments
- a consumer that will call methods onVolumeAttachment.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#attachments(java.util.Collection
)
-
availabilityZone
Volume.Builder availabilityZone(String availabilityZone)
The Availability Zone for the volume.
- Parameters:
availabilityZone
- The Availability Zone for the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createTime
Volume.Builder createTime(Instant createTime)
The time stamp when volume creation was initiated.
- Parameters:
createTime
- The time stamp when volume creation was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
Volume.Builder encrypted(Boolean encrypted)
Indicates whether the volume is encrypted.
- Parameters:
encrypted
- Indicates whether the volume is encrypted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
Volume.Builder kmsKeyId(String kmsKeyId)
The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.
- Parameters:
kmsKeyId
- The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outpostArn
Volume.Builder outpostArn(String outpostArn)
The Amazon Resource Name (ARN) of the Outpost.
- Parameters:
outpostArn
- The Amazon Resource Name (ARN) of the Outpost.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
size
Volume.Builder size(Integer size)
The size of the volume, in GiBs.
- Parameters:
size
- The size of the volume, in GiBs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotId
Volume.Builder snapshotId(String snapshotId)
The snapshot from which the volume was created, if applicable.
- Parameters:
snapshotId
- The snapshot from which the volume was created, if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
Volume.Builder state(String state)
The volume state.
- Parameters:
state
- The volume state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeState
,VolumeState
-
state
Volume.Builder state(VolumeState state)
The volume state.
- Parameters:
state
- The volume state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeState
,VolumeState
-
volumeId
Volume.Builder volumeId(String volumeId)
The ID of the volume.
- Parameters:
volumeId
- The ID of the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
Volume.Builder iops(Integer iops)
The number of I/O operations per second (IOPS). For
gp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.- Parameters:
iops
- The number of I/O operations per second (IOPS). Forgp3
,io1
, andio2
volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2
volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Volume.Builder tags(Collection<Tag> tags)
Any tags assigned to the volume.
- Parameters:
tags
- Any tags assigned to the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Volume.Builder tags(Tag... tags)
Any tags assigned to the volume.
- Parameters:
tags
- Any tags assigned to the volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Volume.Builder tags(Consumer<Tag.Builder>... tags)
Any tags assigned to the volume.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
volumeType
Volume.Builder volumeType(String volumeType)
The volume type.
- Parameters:
volumeType
- The volume type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType
,VolumeType
-
volumeType
Volume.Builder volumeType(VolumeType volumeType)
The volume type.
- Parameters:
volumeType
- The volume type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType
,VolumeType
-
fastRestored
Volume.Builder fastRestored(Boolean fastRestored)
Indicates whether the volume was created using fast snapshot restore.
- Parameters:
fastRestored
- Indicates whether the volume was created using fast snapshot restore.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiAttachEnabled
Volume.Builder multiAttachEnabled(Boolean multiAttachEnabled)
Indicates whether Amazon EBS Multi-Attach is enabled.
- Parameters:
multiAttachEnabled
- Indicates whether Amazon EBS Multi-Attach is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
throughput
Volume.Builder throughput(Integer throughput)
The throughput that the volume supports, in MiB/s.
- Parameters:
throughput
- The throughput that the volume supports, in MiB/s.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseType
Volume.Builder sseType(String sseType)
Reserved for future use.
-
sseType
Volume.Builder sseType(SSEType sseType)
Reserved for future use.
-
-