Package software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.BlockDeviceMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.BlockDeviceMappingProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

@Stability(Stable)
public static interface CfnLaunchTemplate.BlockDeviceMappingProperty
extends software.amazon.jsii.JsiiSerializable

Specifies a block device mapping for a launch template.

You must specify DeviceName plus exactly one of the following properties: Ebs , NoDevice , or VirtualName .

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunchTemplate.BlockDeviceMappingProperty.Builder	builder()
default String	getDeviceName()	The device name (for example, /dev/sdh or xvdh).
default Object	getEbs()	Parameters used to automatically set up EBS volumes when the instance is launched.
default String	getNoDevice()	To omit the device from the block device mapping, specify an empty string.
default String	getVirtualName()	The virtual device name (ephemeralN).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeviceName

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

The device name (for example, /dev/sdh or xvdh).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-devicename

getEbs

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

Parameters used to automatically set up EBS volumes when the instance is launched.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-ebs

getNoDevice

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

To omit the device from the block device mapping, specify an empty string.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-nodevice

getVirtualName

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

The virtual device name (ephemeralN).

Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-blockdevicemapping.html#cfn-ec2-launchtemplate-blockdevicemapping-virtualname

builder

@Stability(Stable)
static CfnLaunchTemplate.BlockDeviceMappingProperty.Builder builder()

Returns:

a CfnLaunchTemplate.BlockDeviceMappingProperty.Builder of CfnLaunchTemplate.BlockDeviceMappingProperty