AWS CDK

2.272.0

interface CfnVolumeProps

Language	Type name
.NET	`Amazon.CDK.AWS.StorageGateway.CfnVolumeProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsstoragegateway#CfnVolumeProps`
Java	`software.amazon.awscdk.services.storagegateway.CfnVolumeProps`
Python	`aws_cdk.aws_storagegateway.CfnVolumeProps`
TypeScript	`aws-cdk-lib` » `aws_storagegateway` » `CfnVolumeProps`

Properties for defining a CfnVolume.

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

Example

// 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

Name	Type	Description
gatewayArn	`string`	The Amazon Resource Name (ARN) of the gateway on which to create the volume.
networkInterfaceId	`string`	The network interface of the gateway on which to expose the iSCSI target.
targetName	`string`	The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
volumeSizeInBytes	`number`	The size of the volume in bytes.
kmsEncrypted?	`boolean \|` `IResolvable`	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.
kmsKey?	`string`	The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
snapshotId?	`string`	The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb).
sourceVolumeArn?	`string`	The ARN of an existing volume from which to create the new volume.
tags?	`CfnTag[]`	A list of up to 50 tags to assign to the volume.

gatewayArn

Type: string

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

networkInterfaceId

Type: string

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

targetName

Type: string

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

volumeSizeInBytes

Type: number

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

kmsEncrypted?

Type: boolean | IResolvable (optional)

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.

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

kmsKey?

Type: string (optional)

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

snapshotId?

Type: string (optional)

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

sourceVolumeArn?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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

← Previous Next →