Package software.amazon.awscdk.services.ec2

Interface EbsDeviceOptions

All Superinterfaces:

EbsDeviceOptionsBase, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

EbsDeviceProps

All Known Implementing Classes:

EbsDeviceOptions.Jsii$Proxy, EbsDeviceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:09.180Z")
@Stability(Stable)
public interface EbsDeviceOptions
extends software.amazon.jsii.JsiiSerializable, EbsDeviceOptionsBase

Block device options for an EBS volume.

Example:

 ImageRecipe imageRecipe = ImageRecipe.Builder.create(this, "BlockDeviceImageRecipe")
         .baseImage(BaseImage.fromSsmParameterName("/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64"))
         .blockDevices(List.of(BlockDevice.builder()
                 .deviceName("/dev/sda1")
                 .volume(BlockDeviceVolume.ebs(100, EbsDeviceOptions.builder()
                         .encrypted(true)
                         .volumeType(EbsDeviceVolumeType.GENERAL_PURPOSE_SSD_GP3)
                         .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EbsDeviceOptions.Builder	A builder for EbsDeviceOptions
static final class	EbsDeviceOptions.Jsii$Proxy	An implementation for EbsDeviceOptions

Method Summary

Modifier and Type	Method	Description
static EbsDeviceOptions.Builder	builder()
default Boolean	getEncrypted()	Specifies whether the EBS volume is encrypted.
default IKey	getKmsKey()	The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

Methods inherited from interface software.amazon.awscdk.services.ec2.EbsDeviceOptionsBase

getDeleteOnTermination, getIops, getThroughput, getVolumeType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncrypted

@Stability(Stable)
@Nullable
default Boolean getEncrypted()

Specifies whether the EBS volume is encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption

Default: false

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances

getKmsKey

@Stability(Stable)
@Nullable
default IKey getKmsKey()

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

You have to ensure that the KMS CMK has the correct permissions to be used by the service launching the ec2 instances.

Default: - If encrypted is true, the default aws/ebs KMS key will be used.

See Also:

• https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#ebs-encryption-requirements

builder

@Stability(Stable)
static EbsDeviceOptions.Builder builder()

Returns:

a EbsDeviceOptions.Builder of EbsDeviceOptions