Package software.amazon.awscdk.services.autoscaling

Interface CfnLaunchConfiguration.BlockDeviceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchConfiguration.BlockDeviceProperty.Jsii$Proxy

Enclosing class:

CfnLaunchConfiguration

@Stability(Stable)
public static interface CfnLaunchConfiguration.BlockDeviceProperty
extends software.amazon.jsii.JsiiSerializable

BlockDevice is a property of the EBS property of the AWS::AutoScaling::LaunchConfiguration BlockDeviceMapping property type that describes an Amazon EBS volume.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunchConfiguration.BlockDeviceProperty.Builder	builder()
default Object	getDeleteOnTermination()	Indicates whether the volume is deleted on instance termination.
default Object	getEncrypted()	Specifies whether the volume should be encrypted.
default Number	getIops()	The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
default String	getSnapshotId()	The snapshot ID of the volume to use.
default Number	getThroughput()	The throughput (MiBps) to provision for a gp3 volume.
default Number	getVolumeSize()	The volume size, in GiBs.
default String	getVolumeType()	The volume type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeleteOnTermination

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

Indicates whether the volume is deleted on instance termination.

For Amazon EC2 Auto Scaling, the default value is true .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-deleteontermination

getEncrypted

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

Specifies whether the volume should be encrypted.

Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.

If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the AWS managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.

For more information, see Use AWS KMS keys to encrypt Amazon EBS volumes in the Amazon EC2 Auto Scaling User Guide .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-encrypted

getIops

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

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

For gp3 and io1 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

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

Iops is supported when the volume type is gp3 or io1 and required only when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-iops

getSnapshotId

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

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-snapshotid

getThroughput

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

The throughput (MiBps) to provision for a gp3 volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-throughput

getVolumeSize

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

The volume size, in GiBs. The following are the supported volumes sizes for each volume type:.

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

You must specify either a SnapshotId or a VolumeSize . If you specify both SnapshotId and VolumeSize , the volume size must be equal or greater than the size of the snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumesize

getVolumeType

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

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide .

Valid values: standard | io1 | gp2 | st1 | sc1 | gp3

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-launchconfiguration-blockdevice.html#cfn-autoscaling-launchconfiguration-blockdevice-volumetype

builder

@Stability(Stable)
static CfnLaunchConfiguration.BlockDeviceProperty.Builder builder()

Returns:

a CfnLaunchConfiguration.BlockDeviceProperty.Builder of CfnLaunchConfiguration.BlockDeviceProperty