Class: Aws::FSx::Types::OntapVolumeConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::OntapVolumeConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

The configuration of an Amazon FSx for NetApp ONTAP volume.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #copy_tags_to_backups ⇒ Boolean

  A boolean flag indicating whether tags for the volume should be copied to backups.

• #flex_cache_endpoint_type ⇒ String

  Specifies the FlexCache endpoint type of the volume.

• #junction_path ⇒ String

  Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address.

• #ontap_volume_type ⇒ String

  Specifies the type of volume.

• #security_style ⇒ String

  The security style for the volume, which can be ‘UNIX`, `NTFS`, or `MIXED`.

• #size_in_megabytes ⇒ Integer

  The configured size of the volume, in megabytes (MBs).

• #snapshot_policy ⇒ String

  Specifies the snapshot policy for the volume.

• #storage_efficiency_enabled ⇒ Boolean

  The volume’s storage efficiency setting.

• #storage_virtual_machine_id ⇒ String

  The ID of the volume’s storage virtual machine.

• #storage_virtual_machine_root ⇒ Boolean

  A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM).

• #tiering_policy ⇒ Types::TieringPolicy

  The volume’s ‘TieringPolicy` setting.

• #uuid ⇒ String

  The volume’s universally unique identifier (UUID).

Instance Attribute Details

#copy_tags_to_backups ⇒ Boolean

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it’s set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn’t specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

Returns:

• (Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#flex_cache_endpoint_type ⇒ String

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

• ‘NONE` specifies that the volume doesn’t have a FlexCache configuration. ‘NONE` is the default.

• ‘ORIGIN` specifies that the volume is the origin volume for a FlexCache volume.

• ‘CACHE` specifies that the volume is a FlexCache volume.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#junction_path ⇒ String

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a ‘JunctionPath` directly below a parent volume junction or on a directory within a volume. A `JunctionPath` for a volume named `vol3` might be `/vol1/vol2/vol3`, or `/vol1/dir2/vol3`, or even `/dir1/dir2/vol3`.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_volume_type ⇒ String

Specifies the type of volume. Valid values are the following:

• ‘RW` specifies a read/write volume. `RW` is the default.

• ‘DP` specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

• ‘LS` specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#security_style ⇒ String

The security style for the volume, which can be ‘UNIX`, `NTFS`, or `MIXED`.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_megabytes ⇒ Integer

The configured size of the volume, in megabytes (MBs).

Returns:

• (Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_policy ⇒ String

Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

• ‘default`: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

• ‘default-1weekly`: This policy is the same as the `default` policy except that it only retains one snapshot from the weekly schedule.

• ‘none`: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

For more information, see [Snapshot policies] in the *Amazon FSx for NetApp ONTAP User Guide*.

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#storage_efficiency_enabled ⇒ Boolean

The volume’s storage efficiency setting.

Returns:

• (Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#storage_virtual_machine_id ⇒ String

The ID of the volume’s storage virtual machine.

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#storage_virtual_machine_root ⇒ Boolean

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to ‘false`. If this value is `true`, then this is the SVM root volume.

This flag is useful when you’re deleting an SVM, because you must first delete all non-root volumes. This flag, when set to ‘false`, helps you identify which volumes to delete before you can delete the SVM.

Returns:

• (Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#tiering_policy ⇒ Types::TieringPolicy

The volume’s ‘TieringPolicy` setting.

Returns:

• (Types::TieringPolicy)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#uuid ⇒ String

The volume’s universally unique identifier (UUID).

Returns:

• (String)

# File 'lib/aws-sdk-fsx/types.rb', line 6272

class OntapVolumeConfiguration < Struct.new(
  :flex_cache_endpoint_type,
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :storage_virtual_machine_id,
  :storage_virtual_machine_root,
  :tiering_policy,
  :uuid,
  :ontap_volume_type,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end