Package software.amazon.awscdk.cfnpropertymixins.services.storagegateway

Interface CfnVolumeMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVolumeMixinProps.Jsii$Proxy

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

Properties for CfnVolumePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.storagegateway.*;
 CfnVolumeMixinProps cfnVolumeMixinProps = CfnVolumeMixinProps.builder()
         .gatewayArn("gatewayArn")
         .kmsEncrypted(false)
         .kmsKey("kmsKey")
         .networkInterfaceId("networkInterfaceId")
         .snapshotId("snapshotId")
         .sourceVolumeArn("sourceVolumeArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetName("targetName")
         .volumeSizeInBytes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnVolumeMixinProps.Builder	builder()
default 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.
default 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.
default 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.
default Number	getVolumeSizeInBytes()	The size of the volume in bytes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGatewayArn

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

The Amazon Resource Name (ARN) of the gateway on which to create the volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-gatewayarn

getKmsEncrypted

@Stability(Stable)
@Nullable
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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-kmsencrypted

getKmsKey

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

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-kmskey

getNetworkInterfaceId

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

The network interface of the gateway on which to expose the iSCSI target.

Only IPv4 addresses are accepted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-networkinterfaceid

getSnapshotId

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

The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-snapshotid

getSourceVolumeArn

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

The ARN of an existing volume from which to create the new volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-sourcevolumearn

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of up to 50 tags to assign to the volume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-tags

getTargetName

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-targetname

getVolumeSizeInBytes

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

The size of the volume in bytes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-volume.html#cfn-storagegateway-volume-volumesizeinbytes

builder

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

Returns:

a CfnVolumeMixinProps.Builder of CfnVolumeMixinProps