interface BlockDeviceMappingProperty

Language	Type name
.NET	`Amazon.CDK.AWS.OpsWorks.CfnInstance.BlockDeviceMappingProperty`
Java	`software.amazon.awscdk.services.opsworks.CfnInstance.BlockDeviceMappingProperty`
Python	`aws_cdk.aws_opsworks.CfnInstance.BlockDeviceMappingProperty`
TypeScript	`@aws-cdk/aws-opsworks` » `CfnInstance` » `BlockDeviceMappingProperty`

Describes a block device mapping.

This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as opsworks from '@aws-cdk/aws-opsworks';
const blockDeviceMappingProperty: opsworks.CfnInstance.BlockDeviceMappingProperty = {
  deviceName: 'deviceName',
  ebs: {
    deleteOnTermination: false,
    iops: 123,
    snapshotId: 'snapshotId',
    volumeSize: 123,
    volumeType: 'volumeType',
  },
  noDevice: 'noDevice',
  virtualName: 'virtualName',
};

Properties

Name	Type	Description
deviceName?	`string`	The device name that is exposed to the instance, such as `/dev/sdh` .
ebs?	`IResolvable` `\|` `EbsBlockDeviceProperty`	An `EBSBlockDevice` that defines how to configure an Amazon EBS volume when the instance is launched.
noDevice?	`string`	Suppresses the specified device included in the AMI's block device mapping.
virtualName?	`string`	The virtual device name.

deviceName?

Type: string (optional)

The device name that is exposed to the instance, such as /dev/sdh .

For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

ebs?

Type: IResolvable | EbsBlockDeviceProperty (optional)

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

You can specify either the VirtualName or Ebs , but not both.

noDevice?

Type: string (optional)

Suppresses the specified device included in the AMI's block device mapping.

virtualName?

Type: string (optional)

The virtual device name.

For more information, see BlockDeviceMapping . You can specify either the VirtualName or Ebs , but not both.