Interface Volume.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Volume.Builder,
,Volume> SdkBuilder<Volume.Builder,
,Volume> SdkPojo
- Enclosing class:
Volume
-
Method Summary
Modifier and TypeMethodDescriptionattachments
(Collection<VolumeAttachment> attachments) attachments
(Consumer<VolumeAttachment.Builder>... attachments) attachments
(VolumeAttachment... attachments) availabilityZone
(String availabilityZone) The Availability Zone for the volume.createTime
(Instant createTime) The time stamp when volume creation was initiated.Indicates whether the volume is encrypted.fastRestored
(Boolean fastRestored) The number of I/O operations per second (IOPS).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.multiAttachEnabled
(Boolean multiAttachEnabled) Indicates whether Amazon EBS Multi-Attach is enabled.outpostArn
(String outpostArn) The Amazon Resource Name (ARN) of the Outpost.The size of the volume, in GiBs.snapshotId
(String snapshotId) The snapshot from which the volume was created, if applicable.The volume state.state
(VolumeState state) The volume state.tags
(Collection<Tag> tags) Any tags assigned to the volume.tags
(Consumer<Tag.Builder>... tags) Any tags assigned to the volume.Any tags assigned to the volume.throughput
(Integer throughput) The throughput that the volume supports, in MiB/s.The ID of the volume.volumeType
(String volumeType) The volume type.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 Details
-
attachments
This parameter is not returned by CreateVolume.
Information about the volume attachments.
- Parameters:
attachments
-This parameter is not returned by CreateVolume.
Information about the volume attachments.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
This parameter is not returned by CreateVolume.
Information about the volume attachments.
- Parameters:
attachments
-This parameter is not returned by CreateVolume.
Information about the volume attachments.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachments
This parameter is not returned by CreateVolume.
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 toattachments(List<VolumeAttachment>)
.- 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:
-
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
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
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
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
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
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
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
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:
-
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:
-
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
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
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
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
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 totags(List<Tag>)
.- 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:
-
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
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:
-
fastRestored
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.
- Parameters:
fastRestored
-This parameter is not returned by CreateVolume.
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
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
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
This parameter is not returned by CreateVolume.
Reserved for future use.
- Parameters:
sseType
-This parameter is not returned by CreateVolume.
Reserved for future use.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sseType
This parameter is not returned by CreateVolume.
Reserved for future use.
- Parameters:
sseType
-This parameter is not returned by CreateVolume.
Reserved for future use.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-