aws-cdk-lib.aws_opsworks.CfnInstance.EbsBlockDeviceProperty

interface EbsBlockDeviceProperty

LanguageType name
.NETAmazon.CDK.AWS.OpsWorks.CfnInstance.EbsBlockDeviceProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopsworks#CfnInstance_EbsBlockDeviceProperty
Javasoftware.amazon.awscdk.services.opsworks.CfnInstance.EbsBlockDeviceProperty
Pythonaws_cdk.aws_opsworks.CfnInstance.EbsBlockDeviceProperty
TypeScript aws-cdk-lib » aws_opsworks » CfnInstance » EbsBlockDeviceProperty

Describes an Amazon EBS volume.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opsworks as opsworks } from 'aws-cdk-lib';
const ebsBlockDeviceProperty: opsworks.CfnInstance.EbsBlockDeviceProperty = {
  deleteOnTermination: false,
  iops: 123,
  snapshotId: 'snapshotId',
  volumeSize: 123,
  volumeType: 'volumeType',
};

Properties

NameTypeDescription
deleteOnTermination?boolean | IResolvableWhether the volume is deleted on instance termination.
iops?numberThe number of I/O operations per second (IOPS) that the volume supports.
snapshotId?stringThe snapshot ID.
volumeSize?numberThe volume size, in GiB.
volumeType?stringThe volume type.

deleteOnTermination?

Type: boolean | IResolvable (optional)

Whether the volume is deleted on instance termination.


iops?

Type: number (optional)

The number of I/O operations per second (IOPS) that the volume supports.

For more information, see EbsBlockDevice .


snapshotId?

Type: string (optional)

The snapshot ID.


volumeSize?

Type: number (optional)

The volume size, in GiB.

For more information, see EbsBlockDevice .


volumeType?

Type: string (optional)

The volume type.

gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).