Package software.amazon.awscdk.services.storagegateway

Interface CfnVolumeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnVolumeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:05:02.745Z") @Stability(Stable) public interface CfnVolumeProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnVolume.

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.storagegateway.*;
 CfnVolumeProps cfnVolumeProps = CfnVolumeProps.builder()
         .gatewayArn("gatewayArn")
         .networkInterfaceId("networkInterfaceId")
         .targetName("targetName")
         .volumeSizeInBytes(123)
         // the properties below are optional
         .kmsEncrypted(false)
         .kmsKey("kmsKey")
         .snapshotId("snapshotId")
         .sourceVolumeArn("sourceVolumeArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnVolumeProps.Builder
    builder()
     
    String
    getGatewayArn()
    The Amazon Resource Name (ARN) of the gateway on which to create the volume.
    default Object
    getKmsEncrypted()
    Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3.
    default String
    getKmsKey()
    The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
    String
    getNetworkInterfaceId()
    The network interface of the gateway on which to expose the iSCSI target.
    default String
    getSnapshotId()
    The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
    default String
    getSourceVolumeArn()
    The ARN of an existing volume from which to create the new volume.
    default List<CfnTag>
    getTags()
    A list of up to 50 tags to assign to the volume.
    String
    getTargetName()
    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
    Number
    getVolumeSizeInBytes()
    The size of the volume in bytes.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson