AWS::StorageGateway::Volume

StorageGateway Volume

Creates a cached iSCSI volume on a Storage Gateway. A cached volume stores data in Amazon S3 and retains a copy of frequently accessed data subsets locally.

Properties

9 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`GatewayARN`	`string`	RequiredCreate-only
`NetworkInterfaceId`	`string`	RequiredCreate-only
`TargetName`	`string`	RequiredCreate-only
`VolumeSizeInBytes`	`number`	RequiredCreate-only
`KMSEncrypted`	`boolean`	Create-onlyWrite-only
`KMSKey`	`string`	Create-only
`SnapshotId`	`string`	Create-onlyWrite-only
`SourceVolumeARN`	`string`	Create-onlyWrite-only
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`CreatedDate`	`string`	The date the volume was created.
`TargetARN`	`string`	The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI target name.
`VolumeARN`	`string`	The Amazon Resource Name (ARN) of the storage volume.
`VolumeAttachmentStatus`	`string`	Indicates whether the storage volume is attached to or detached from the gateway.
`VolumeId`	`string`	The unique identifier of the volume, extracted from the ARN.
`VolumeStatus`	`string`	The status of the storage volume.
`VolumeType`	`string`	The type of the volume (CACHED iSCSI).
`VolumeUsedInBytes`	`number`	The size of the data stored on the volume in bytes.

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::Volume

Resources:
  MyResource:
    Type: AWS::StorageGateway::Volume
    Properties:
      GatewayARN: "arn:aws:service:region:account:resource"
      TargetName: "my-targetname"
      NetworkInterfaceId: "my-networkinterfaceid"
      VolumeSizeInBytes: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

storagegateway:CreateCachediSCSIVolumestoragegateway:DescribeCachediSCSIVolumesstoragegateway:AddTagsToResourcekms:DescribeKeykms:CreateGrantkms:GenerateDataKeyWithoutPlaintext

read

storagegateway:DescribeCachediSCSIVolumesstoragegateway:ListTagsForResource

update

storagegateway:DescribeCachediSCSIVolumesstoragegateway:AddTagsToResourcestoragegateway:RemoveTagsFromResourcestoragegateway:ListTagsForResource

delete

storagegateway:DeleteVolumestoragegateway:DescribeCachediSCSIVolumesstoragegateway:ListTagsForResource

list

storagegateway:ListVolumes

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

Properties17

Required4

TaggingSupported

Primary IDVolumeARN

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

GatewayARNTargetNameNetworkInterfaceIdVolumeSizeInBytesSnapshotIdSourceVolumeARNKMSEncryptedKMSKey

Related Resources

External Links

AWS Documentation