AWS::FSx::Volume OriginSnapshot - Amazon CloudFormation
SyntaxProperties
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).

AWS::FSx::Volume OriginSnapshot

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

Syntax

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

JSON

{
  "CopyStrategy" : String,
  "SnapshotARN" : String
}

YAML

  CopyStrategy: String
  SnapshotARN: String

Properties

CopyStrategy

Specifies the strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

  • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

Note

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

Required: Yes

Type: String

Allowed values: CLONE | FULL_COPY | INCREMENTAL_COPY

Update requires: Replacement

SnapshotARN

Specifies the snapshot to use when creating an OpenZFS volume from a snapshot.

Required: Yes

Type: String

Update requires: Replacement