Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.Types.UpdateOntapVolumeConfiguration

Description

Synopsis

Documentation

data UpdateOntapVolumeConfiguration Source #

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

See: newUpdateOntapVolumeConfiguration smart constructor.

Constructors

UpdateOntapVolumeConfiguration'

Fields

copyTagsToBackups :: Maybe Bool
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.
junctionPath :: Maybe Text
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
securityStyle :: Maybe SecurityStyle
The security style for the volume, which can be UNIX. NTFS, or MIXED.
sizeInMegabytes :: Maybe Natural
Specifies the size of the volume in megabytes.
snapshotPolicy :: Maybe Text
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.
storageEfficiencyEnabled :: Maybe Bool
Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
tieringPolicy :: Maybe TieringPolicy
Update the volume's data tiering policy.

Instances

Instances details

ToJSON UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods toJSON :: UpdateOntapVolumeConfiguration -> Value # toEncoding :: UpdateOntapVolumeConfiguration -> Encoding # toJSONList :: [UpdateOntapVolumeConfiguration] -> Value # toEncodingList :: [UpdateOntapVolumeConfiguration] -> Encoding #
Generic UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Associated Types type Rep UpdateOntapVolumeConfiguration :: Type -> Type # Methods from :: UpdateOntapVolumeConfiguration -> Rep UpdateOntapVolumeConfiguration x # to :: Rep UpdateOntapVolumeConfiguration x -> UpdateOntapVolumeConfiguration #
Read UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods readsPrec :: Int -> ReadS UpdateOntapVolumeConfiguration # readList :: ReadS [UpdateOntapVolumeConfiguration] # readPrec :: ReadPrec UpdateOntapVolumeConfiguration # readListPrec :: ReadPrec [UpdateOntapVolumeConfiguration] #
Show UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods showsPrec :: Int -> UpdateOntapVolumeConfiguration -> ShowS # show :: UpdateOntapVolumeConfiguration -> String # showList :: [UpdateOntapVolumeConfiguration] -> ShowS #
NFData UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods rnf :: UpdateOntapVolumeConfiguration -> () #
Eq UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods (==) :: UpdateOntapVolumeConfiguration -> UpdateOntapVolumeConfiguration -> Bool # (/=) :: UpdateOntapVolumeConfiguration -> UpdateOntapVolumeConfiguration -> Bool #
Hashable UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration Methods hashWithSalt :: Int -> UpdateOntapVolumeConfiguration -> Int # hash :: UpdateOntapVolumeConfiguration -> Int #
type Rep UpdateOntapVolumeConfiguration Source #
Instance details Defined in Amazonka.FSx.Types.UpdateOntapVolumeConfiguration type Rep UpdateOntapVolumeConfiguration = D1 ('MetaData "UpdateOntapVolumeConfiguration" "Amazonka.FSx.Types.UpdateOntapVolumeConfiguration" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "UpdateOntapVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "copyTagsToBackups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "junctionPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "securityStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityStyle)))) :: ((S1 ('MetaSel ('Just "sizeInMegabytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "snapshotPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "storageEfficiencyEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "tieringPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TieringPolicy))))))

newUpdateOntapVolumeConfiguration :: UpdateOntapVolumeConfiguration Source #

Create a value of UpdateOntapVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:copyTagsToBackups:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_copyTagsToBackups - 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.

$sel:junctionPath:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_junctionPath - Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.

$sel:securityStyle:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_securityStyle - The security style for the volume, which can be UNIX. NTFS, or MIXED.

$sel:sizeInMegabytes:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_sizeInMegabytes - Specifies the size of the volume in megabytes.

$sel:snapshotPolicy:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_snapshotPolicy - 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.

$sel:storageEfficiencyEnabled:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_storageEfficiencyEnabled - Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.

$sel:tieringPolicy:UpdateOntapVolumeConfiguration', updateOntapVolumeConfiguration_tieringPolicy - Update the volume's data tiering policy.

updateOntapVolumeConfiguration_copyTagsToBackups :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #

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.

updateOntapVolumeConfiguration_junctionPath :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #

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

updateOntapVolumeConfiguration_securityStyle :: Lens' UpdateOntapVolumeConfiguration (Maybe SecurityStyle) Source #

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

updateOntapVolumeConfiguration_sizeInMegabytes :: Lens' UpdateOntapVolumeConfiguration (Maybe Natural) Source #

Specifies the size of the volume in megabytes.

updateOntapVolumeConfiguration_snapshotPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe Text) Source #

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.

updateOntapVolumeConfiguration_storageEfficiencyEnabled :: Lens' UpdateOntapVolumeConfiguration (Maybe Bool) Source #

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

updateOntapVolumeConfiguration_tieringPolicy :: Lens' UpdateOntapVolumeConfiguration (Maybe TieringPolicy) Source #

Update the volume's data tiering policy.