CfnVolumeProps Struct
Properties for defining a CfnVolume.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_storagegateway as storagegateway } from 'aws-cdk-lib';
const cfnVolumeProps: storagegateway.CfnVolumeProps = {
gatewayArn: 'gatewayArn',
networkInterfaceId: 'networkInterfaceId',
targetName: 'targetName',
volumeSizeInBytes: 123,
// the properties below are optional
kmsEncrypted: false,
kmsKey: 'kmsKey',
snapshotId: 'snapshotId',
sourceVolumeArn: 'sourceVolumeArn',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
The Amazon Resource Name (ARN) of the gateway on which to create the volume.
kmsEncryptedoptionalboolean | IResolvablekms_encryptedoptionaltyping.Union[bool, IResolvable]kmsEncryptedoptionalBooleanKmsEncryptedoptionalboolKmsEncryptedoptionalinterface{}#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.
kmsKeyoptionalstringkms_keyoptionalstrkmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptional*string#The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
networkInterfaceIdstringnetwork_interface_idstrnetworkInterfaceIdStringNetworkInterfaceIdstringNetworkInterfaceId*stringrequired#The network interface of the gateway on which to expose the iSCSI target.
Only IPv4 addresses are accepted.
snapshotIdoptionalstringsnapshot_idoptionalstrsnapshotIdoptionalStringSnapshotIdoptionalstringSnapshotIdoptional*string#The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
sourceVolumeArnoptionalstringsource_volume_arnoptionalstrsourceVolumeArnoptionalStringSourceVolumeArnoptionalstringSourceVolumeArnoptional*string#The ARN of an existing volume from which to create the new volume.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#A list of up to 50 tags to assign to the volume.
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
volumeSizeInBytesnumbervolume_size_in_bytesint | floatvolumeSizeInBytesNumberVolumeSizeInBytesdoubleVolumeSizeInBytes*float64required#The size of the volume in bytes.