Package software.amazon.awscdk.services.ec2

Interface CfnVolumeAttachmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumeAttachmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:50.424Z")
@Stability(Stable)
public interface CfnVolumeAttachmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVolumeAttachment.

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.*;
 CfnVolumeAttachmentProps cfnVolumeAttachmentProps = CfnVolumeAttachmentProps.builder()
         .instanceId("instanceId")
         .volumeId("volumeId")
         // the properties below are optional
         .device("device")
         .ebsCardIndex(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolumeAttachmentProps.Builder	builder()
default String	getDevice()	The device name (for example, /dev/sdh or xvdh ).
default Number	getEbsCardIndex()	The index of the EBS card.
Object	getInstanceId()	The ID of the instance to which the volume attaches.
Object	getVolumeId()	The ID of the Amazon EBS volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceId

@Stability(Stable)
@NotNull
Object getInstanceId()

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.

Returns union: either String or IInstanceRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-instanceid

getVolumeId

@Stability(Stable)
@NotNull
Object getVolumeId()

The ID of the Amazon EBS volume.

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.

Returns union: either String or IVolumeRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-volumeid

getDevice

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-device

getEbsCardIndex

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

The index of the EBS card.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volumeattachment.html#cfn-ec2-volumeattachment-ebscardindex

builder

@Stability(Stable)
static CfnVolumeAttachmentProps.Builder builder()

Returns:

a CfnVolumeAttachmentProps.Builder of CfnVolumeAttachmentProps