A snapshot of an Amazon FSx for OpenZFS volume.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::FSx::Snapshot",
"Properties" : {
"Name" : String,
"Tags" : [ Tag, ... ],
"VolumeId" : String
}
}
Properties
Name-
The name of the snapshot.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_:.-]{1,203}$Minimum:
1Maximum:
203Update requires: No interruption
-
A list of
Tagvalues, with a maximum of 50 elements.Required: No
Type: Array of Tag
Update requires: No interruption
VolumeId-
The ID of the volume that the snapshot is of.
Required: Yes
Type: String
Pattern:
^(fsvol-[0-9a-f]{17,})$Minimum:
23Maximum:
23Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the snapshot. For example:
{"Ref":"logical_snapshot_id"}
Returns fsvolsnap-0123456789abcedf5.
For more information about using the Ref function, see Ref.
Fn::GetAtt
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.
ResourceARN-
Returns the snapshot's Amazon Resource Name (ARN).
Example:
arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5
