AWS::FSx::Snapshot - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


A snapshot of an Amazon FSx for OpenZFS volume.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::FSx::Snapshot", "Properties" : { "Name" : String, "Tags" : [ Tag, ... ], "VolumeId" : String } }


Type: AWS::FSx::Snapshot Properties: Name: String Tags: - Tag VolumeId: String



The name of the snapshot.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_:.-]{1,203}$

Minimum: 1

Maximum: 203

Update requires: No interruption


A list of Tag values, with a maximum of 50 elements.

Required: No

Type: Array of Tag

Update requires: No interruption


The ID of the volume that the snapshot is of.

Required: Yes

Type: String

Pattern: ^(fsvol-[0-9a-f]{17,})$

Minimum: 23

Maximum: 23

Update requires: Replacement

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the snapshot. For example:


Returns fsvolsnap-0123456789abcedf5.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


Returns the snapshot's Amazon Resource Name (ARN).

Example: arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5