AWS::FSx::Volume

FSx Volume

Resource Type definition for AWS::FSx::Volume

Properties

6 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
Name
string
Required
BackupId
string
Create-onlyWrite-only
OntapConfiguration
OntapConfiguration
OpenZFSConfiguration
OpenZFSConfiguration
Tags
Array<Tag>
VolumeType
string
Create-only

Return Values

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

AttributeTypeDescription
ResourceARNstringReturns the volume's Amazon Resource Name (ARN).
UUIDstringReturns the volume's ID.
VolumeIdstringReturns the volume's universally unique identifier (UUID).

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::FSx::Volume

Resources:
  MyResource:
    Type: AWS::FSx::Volume
    Properties:
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

fsx:CreateVolumefsx:CreateVolumeFromBackupfsx:TagResourcefsx:DescribeVolumes

read

fsx:DescribeVolumesfsx:ListTagsForResource

update

fsx:UpdateVolumefsx:DescribeVolumesfsx:TagResourcefsx:UntagResourcefsx:ListTagsForResource

delete

fsx:DeleteVolumefsx:DescribeVolumesfsx:DescribeStorageVirtualMachinesfsx:TagResource

list

fsx:DescribeVolumes

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

ServiceFSx
Properties9
Required1
TaggingSupported
Primary IDVolumeId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

BackupIdVolumeTypeOntapConfiguration/OntapVolumeTypeOntapConfiguration/StorageVirtualMachineIdOntapConfiguration/VolumeStyleOntapConfiguration/AggregateConfigurationOntapConfiguration/AggregateConfiguration/AggregatesOntapConfiguration/AggregateConfiguration/ConstituentsPerAggregateOntapConfiguration/SnaplockConfiguration/SnaplockTypeOpenZFSConfiguration/OriginSnapshotOpenZFSConfiguration/OriginSnapshot/CopyStrategyOpenZFSConfiguration/OriginSnapshot/SnapshotARNOpenZFSConfiguration/ParentVolumeId

Related Resources

External Links