Skip to content
v2.273.0

CfnVolumeAttachmentProps Struct ​

Properties for defining a CfnVolumeAttachment.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnVolumeAttachmentProps: ec2.CfnVolumeAttachmentProps = {
  instanceId: 'instanceId',
  volumeId: 'volumeId',

  // the properties below are optional
  device: 'device',
  ebsCardIndex: 123,
};

Properties ​

devicestringdevicestrdeviceStringDevicestringDevice*string#
The device name (for example, `/dev/sdh` or `xvdh` ).
ebsCardIndexnumberebs_card_indexint | floatebsCardIndexNumberEbsCardIndexdoubleEbsCardIndex*float64#
The index of the EBS card.

Some instance types support multiple EBS cards. The default EBS card index is 0.

instanceIdstring | IInstanceRefinstance_idtyping.Union[str, IInstanceRef]instanceIdStringInstanceIdstringInstanceIdinterface{}required#
The ID of the instance to which the volume attaches.

This value can be a reference to an AWS::EC2::Instance resource, or it can be the physical ID of an existing EC2 instance.

volumeIdstring | IVolumeRefvolume_idtyping.Union[str, IVolumeRef]volumeIdStringVolumeIdstringVolumeIdinterface{}required#
The ID of the Amazon EBS volume.
notes

The volume and instance must be within the same Availability Zone. This value can be a reference to an AWS::EC2::Volume resource, or it can be the volume ID of an existing Amazon EBS volume.

Used as props by ​