Class: Aws::FSx::Types::UpdateOntapVolumeConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::UpdateOntapVolumeConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

Used to specify changes to the ONTAP configuration for the volume you are updating.

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.

• #junction_path ⇒ String

  Specifies the location in the SVM’s namespace where the volume is mounted.

• #security_style ⇒ String

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

• #size_in_megabytes ⇒ Integer

  Specifies the size of the volume in megabytes.

• #snapshot_policy ⇒ String

  Specifies the snapshot policy for the volume.

• #storage_efficiency_enabled ⇒ Boolean

  Default is ‘false`.

• #tiering_policy ⇒ Types::TieringPolicy

  Update the volume’s data tiering policy.

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 8172

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#junction_path ⇒ String

Specifies the location in the SVM’s namespace where the volume is mounted. The ‘JunctionPath` must have a leading forward slash, such as `/vol3`.

Returns:

• (String)

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

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :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 8172

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_megabytes ⇒ Integer

Specifies the size of the volume in megabytes.

Returns:

• (Integer)

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

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :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 8172

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#storage_efficiency_enabled ⇒ Boolean

Default is ‘false`. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.

Returns:

• (Boolean)

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

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end

#tiering_policy ⇒ Types::TieringPolicy

Update the volume’s data tiering policy.

Returns:

• (Types::TieringPolicy)

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

class UpdateOntapVolumeConfiguration < Struct.new(
  :junction_path,
  :security_style,
  :size_in_megabytes,
  :storage_efficiency_enabled,
  :tiering_policy,
  :snapshot_policy,
  :copy_tags_to_backups)
  SENSITIVE = []
  include Aws::Structure
end