Class EbsDeviceSnapshotOptions.Builder
java.lang.Object
software.amazon.awscdk.services.autoscaling.EbsDeviceSnapshotOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<EbsDeviceSnapshotOptions>
- Enclosing interface:
EbsDeviceSnapshotOptions
@Stability(Stable)
public static final class EbsDeviceSnapshotOptions.Builder
extends Object
implements software.amazon.jsii.Builder<EbsDeviceSnapshotOptions>
A builder for
EbsDeviceSnapshotOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.deleteOnTermination
(Boolean deleteOnTermination) Sets the value ofEbsDeviceOptionsBase.getDeleteOnTermination()
Sets the value ofEbsDeviceOptionsBase.getIops()
throughput
(Number throughput) Sets the value ofEbsDeviceOptionsBase.getThroughput()
volumeSize
(Number volumeSize) Sets the value ofEbsDeviceSnapshotOptions.getVolumeSize()
volumeType
(EbsDeviceVolumeType volumeType) Sets the value ofEbsDeviceOptionsBase.getVolumeType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
volumeSize
Sets the value ofEbsDeviceSnapshotOptions.getVolumeSize()
- Parameters:
volumeSize
- The volume size, in Gibibytes (GiB). If you specify volumeSize, it must be equal or greater than the size of the snapshot.- Returns:
this
-
deleteOnTermination
@Stability(Stable) public EbsDeviceSnapshotOptions.Builder deleteOnTermination(Boolean deleteOnTermination) Sets the value ofEbsDeviceOptionsBase.getDeleteOnTermination()
- Parameters:
deleteOnTermination
- Indicates whether to delete the volume when the instance is terminated.- Returns:
this
-
iops
Sets the value ofEbsDeviceOptionsBase.getIops()
- Parameters:
iops
- The number of I/O operations per second (IOPS) to provision for the volume. Must only be set forvolumeType
:EbsDeviceVolumeType.IO1
The maximum ratio of IOPS to volume size (in GiB) is 50:1, so for 5,000 provisioned IOPS, you need at least 100 GiB storage on the volume.
- Returns:
this
-
throughput
Sets the value ofEbsDeviceOptionsBase.getThroughput()
- Parameters:
throughput
- The throughput that the volume supports, in MiB/s Takes a minimum of 125 and maximum of 1000.- Returns:
this
-
volumeType
@Stability(Stable) public EbsDeviceSnapshotOptions.Builder volumeType(EbsDeviceVolumeType volumeType) Sets the value ofEbsDeviceOptionsBase.getVolumeType()
- Parameters:
volumeType
- The EBS volume type.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<EbsDeviceSnapshotOptions>
- Returns:
- a new instance of
EbsDeviceSnapshotOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-