2.248.0

interface OriginSnapshotProperty

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.FSx.CfnVolumePropsMixin.OriginSnapshotProperty
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsfsx#CfnVolumePropsMixin_OriginSnapshotProperty
Javasoftware.amazon.awscdk.cfnpropertymixins.services.fsx.CfnVolumePropsMixin.OriginSnapshotProperty
Pythonaws_cdk.cfn_property_mixins.aws_fsx.CfnVolumePropsMixin.OriginSnapshotProperty
TypeScript @aws-cdk/cfn-property-mixins » aws_fsx » CfnVolumePropsMixin » OriginSnapshotProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-originsnapshot.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from '@aws-cdk/cfn-property-mixins';
const originSnapshotProperty: fsx.CfnVolumePropsMixin.OriginSnapshotProperty = {
  copyStrategy: 'copyStrategy',
  snapshotArn: 'snapshotArn',
};

Properties

NameTypeDescription
copyStrategy?stringSpecifies the strategy used when copying data from the snapshot to the new volume.
snapshotArn?stringSpecifies the snapshot to use when creating an OpenZFS volume from a snapshot.

copyStrategy?

Type: string (optional)

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.

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-originsnapshot.html#cfn-fsx-volume-originsnapshot-copystrategy

snapshotArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-originsnapshot.html#cfn-fsx-volume-originsnapshot-snapshotarn

← PreviousNext →