software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.EbsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.EbsProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

@Stability(value=Stable)
public static interface CfnLaunchTemplate.EbsProperty
extends software.amazon.jsii.JsiiSerializable

Parameters for a block device for an EBS volume in an Amazon EC2 launch template.

Ebs is a property of AWS::EC2::LaunchTemplate BlockDeviceMapping .

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.*;
 EbsProperty ebsProperty = EbsProperty.builder()
         .deleteOnTermination(false)
         .encrypted(false)
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .snapshotId("snapshotId")
         .throughput(123)
         .volumeSize(123)
         .volumeType("volumeType")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnLaunchTemplate.EbsProperty.Builder	builder()
default Object	getDeleteOnTermination() Indicates whether the EBS volume is deleted on instance termination.
default Object	getEncrypted() Indicates whether the EBS volume is encrypted.
default Number	getIops() The number of I/O operations per second (IOPS).
default String	getKmsKeyId() The ARN of the symmetric AWS Key Management Service ( AWS KMS ) CMK used for encryption.
default String	getSnapshotId() The ID of the snapshot.
default Number	getThroughput() The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.
default Number	getVolumeSize() The size of the volume, in GiBs.
default String	getVolumeType() The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeleteOnTermination

@Stability(value=Stable)
 @Nullable
default Object getDeleteOnTermination()

Indicates whether the EBS volume is deleted on instance termination.

getEncrypted

@Stability(value=Stable)
 @Nullable
default Object getEncrypted()

Indicates whether the EBS volume is encrypted.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

getIops

@Stability(value=Stable)
 @Nullable
default Number getIops()

The number of I/O operations per second (IOPS).

For gp3 , io1 , and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

• gp3 : 3,000-16,000 IOPS
• io1 : 100-64,000 IOPS
• io2 : 100-64,000 IOPS

For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System . Other instance families guarantee performance up to 32,000 IOPS.

This parameter is supported for io1 , io2 , and gp3 volumes only. This parameter is not supported for gp2 , st1 , sc1 , or standard volumes.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

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

getSnapshotId

@Stability(value=Stable)
 @Nullable
default String getSnapshotId()

The ID of the snapshot.

getThroughput

@Stability(value=Stable)
 @Nullable
default Number getThroughput()

The throughput to provision for a `gp3` volume, with a maximum of 1,000 MiB/s.

Valid Range: Minimum value of 125. Maximum value of 1000.

getVolumeSize

@Stability(value=Stable)
 @Nullable
default Number getVolumeSize()

The size of the volume, in GiBs.

You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

• gp2 and gp3 : 1-16,384
• io1 and io2 : 4-16,384
• st1 and sc1 : 125-16,384
• standard : 1-1,024

getVolumeType

@Stability(value=Stable)
 @Nullable
default String getVolumeType()

The volume type.

For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide .

builder

@Stability(value=Stable)
static CfnLaunchTemplate.EbsProperty.Builder builder()

Returns:

a CfnLaunchTemplate.EbsProperty.Builder of CfnLaunchTemplate.EbsProperty