Class: AWSCDK::FSX::CfnVolume::OriginSnapshotProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::FSX::CfnVolume::OriginSnapshotProperty

Defined in:

fsx/cfn_volume.rb

Overview

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

Instance Attribute Summary

• #copy_strategy ⇒ String readonly

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

• #snapshot_arn ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(copy_strategy:, snapshot_arn:) ⇒ OriginSnapshotProperty constructor

  A new instance of OriginSnapshotProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(copy_strategy:, snapshot_arn:) ⇒ OriginSnapshotProperty

Returns a new instance of OriginSnapshotProperty.

Parameters:

• copy_strategy (String) —

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

• snapshot_arn (String) —

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

# File 'fsx/cfn_volume.rb', line 1131

def initialize(copy_strategy:, snapshot_arn:)
  @copy_strategy = copy_strategy
  Jsii::Type.check_type(@copy_strategy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "copyStrategy")
  @snapshot_arn = snapshot_arn
  Jsii::Type.check_type(@snapshot_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotArn")
end

Instance Attribute Details

#copy_strategy ⇒ String (readonly)

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 .

Returns:

• (String)

See Also:

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

# File 'fsx/cfn_volume.rb', line 1149

def copy_strategy
  @copy_strategy
end

#snapshot_arn ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'fsx/cfn_volume.rb', line 1154

def snapshot_arn
  @snapshot_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'fsx/cfn_volume.rb', line 1156

def self.jsii_properties
  {
    :copy_strategy => "copyStrategy",
    :snapshot_arn => "snapshotArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'fsx/cfn_volume.rb', line 1163

def to_jsii
  result = {}
  result.merge!({
    "copyStrategy" => @copy_strategy,
    "snapshotArn" => @snapshot_arn,
  })
  result.compact
end