AWS::StorageGateway::Tape

StorageGateway Tape

Creates a virtual tape with a user-defined barcode on a Tape Gateway (VTL). A virtual tape is stored in Amazon S3 and can be archived to S3 Glacier or S3 Glacier Deep Archive.

Properties

8 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`GatewayARN`	`string`	RequiredCreate-only
`TapeSizeInBytes`	`number`	RequiredCreate-only
`KMSEncrypted`	`boolean`	Create-onlyWrite-only
`KMSKey`	`string`	Create-only
`PoolId`	`string`	Create-only
`Tags`	`Array<Tag>`
`TapeBarcode`	`string`	Create-only
`Worm`	`boolean`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`TapeARN`	`string`	The Amazon Resource Name (ARN) of the virtual tape.
`TapeCreatedDate`	`string`	The date and time that the virtual tape was created.
`TapeStatus`	`string`	The current status of the virtual tape.
`TapeUsedInBytes`	`number`	The size, in bytes, of data stored on the virtual tape.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::StorageGateway::Tape

Resources:
  MyResource:
    Type: AWS::StorageGateway::Tape
    Properties:
      GatewayARN: "arn:aws:service:region:account:resource"
      TapeSizeInBytes: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

storagegateway:CreateTapeWithBarcodestoragegateway:AddTagsToResourcestoragegateway:ListTapesstoragegateway:DescribeTapesstoragegateway:ListTagsForResourcekms:DescribeKeykms:CreateGrantkms:GenerateDataKeyWithoutPlaintext

read

storagegateway:ListTapesstoragegateway:DescribeTapesstoragegateway:ListTagsForResource

update

storagegateway:ListTapesstoragegateway:DescribeTapesstoragegateway:AddTagsToResourcestoragegateway:RemoveTagsFromResourcestoragegateway:ListTagsForResource

delete

storagegateway:ListTapesstoragegateway:DescribeTapesstoragegateway:DeleteTapestoragegateway:ListTagsForResource

list

storagegateway:ListTapes

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceStorageGateway

Properties12

Required2

TaggingSupported

Primary IDTapeARN

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

GatewayARNTapeBarcodeTapeSizeInBytesKMSEncryptedKMSKeyPoolIdWorm

Related Resources

External Links

AWS Documentation