@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:32.807Z") public interface EbsDeviceProps extends EbsDeviceSnapshotOptions, EbsDeviceOptions
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; import software.amazon.awscdk.services.kms.*; Key key; EbsDeviceProps ebsDeviceProps = EbsDeviceProps.builder() .deleteOnTermination(false) .encrypted(false) .iops(123) .kmsKey(key) .snapshotId("snapshotId") .volumeSize(123) .volumeType(EbsDeviceVolumeType.STANDARD) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
EbsDeviceProps.Builder
A builder for
EbsDeviceProps |
static class |
EbsDeviceProps.Jsii$Proxy
An implementation for
EbsDeviceProps |
Modifier and Type | Method and Description |
---|---|
static EbsDeviceProps.Builder |
builder() |
default java.lang.Boolean |
getDeleteOnTermination()
Indicates whether to delete the volume when the instance is terminated.
|
default java.lang.Number |
getIops()
The number of I/O operations per second (IOPS) to provision for the volume.
|
default java.lang.String |
getSnapshotId()
The snapshot ID of the volume to use.
|
default EbsDeviceVolumeType |
getVolumeType()
The EBS volume type.
|
getVolumeSize
getEncrypted, getKmsKey
default java.lang.String getSnapshotId()
Default: - No snapshot will be used
default java.lang.Boolean getDeleteOnTermination()
Default: - true for Amazon EC2 Auto Scaling, false otherwise (e.g. EBS)
getDeleteOnTermination
in interface EbsDeviceOptionsBase
default java.lang.Number getIops()
Must only be set for {@link volumeType}: {@link 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.
Default: - none, required for EbsDeviceVolumeType.IO1
getIops
in interface EbsDeviceOptionsBase
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
default EbsDeviceVolumeType getVolumeType()
Default: EbsDeviceVolumeType.GP2
getVolumeType
in interface EbsDeviceOptionsBase
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html
static EbsDeviceProps.Builder builder()
builder
in interface EbsDeviceOptions
builder
in interface EbsDeviceOptionsBase
builder
in interface EbsDeviceSnapshotOptions
EbsDeviceProps.Builder
of EbsDeviceProps