AWS CDK

2.272.0

interface CfnTapeProps

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

Properties for defining a CfnTape.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-storagegateway-tape.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 cfnTapeProps: storagegateway.CfnTapeProps = {
  gatewayArn: 'gatewayArn',
  tapeSizeInBytes: 123,

  // the properties below are optional
  kmsEncrypted: false,
  kmsKey: 'kmsKey',
  poolId: 'poolId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tapeBarcode: 'tapeBarcode',
  worm: false,
};

Properties

Name	Type	Description
gatewayArn	`string`	The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape.
tapeSizeInBytes	`number`	The size, in bytes, of the virtual tape that you want to create.
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.
poolId?	`string`	The ID of the pool that you want to add your tape to for archiving.
tags?	`CfnTag[]`	A list of up to 50 tags to assign to the virtual tape.
tapeBarcode?	`string`	The barcode that you want to assign to the virtual tape.
worm?	`boolean \|` `IResolvable`	Set to true to create a write-once-read-many (WORM) virtual tape.

gatewayArn

Type: string

The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape.

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

tapeSizeInBytes

Type: number

The size, in bytes, of the virtual tape that you want to create.

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

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.

Optional.

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

kmsKey?

Type: string (optional)

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

This value must be set if KMSEncrypted is true.

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

poolId?

Type: string (optional)

The ID of the pool that you want to add your tape to for archiving.

Tapes in this pool are archived in the S3 storage class that is associated with the pool.

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

tags?

Type: CfnTag[] (optional)

A list of up to 50 tags to assign to the virtual tape.

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

tapeBarcode?

Type: string (optional)

The barcode that you want to assign to the virtual tape.

Barcodes cannot be reused, even after a tape is deleted.

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

worm?

Type: boolean | IResolvable (optional)

Set to true to create a write-once-read-many (WORM) virtual tape.

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

← Previous Next →