Skip to content

UpdateOntapVolumeConfiguration

Source code in docs_src/capo_fsx/types/update_ontap_volume_configuration.py
class UpdateOntapVolumeConfiguration(TypedDict, closed=True):
    junction_path: NotRequired["capo_fsx.types.junction_path.JunctionPath"]
    """<p>Specifies the location in the SVM's namespace where the volume is mounted. The <code>JunctionPath</code> must have a leading forward slash, such as <code>/vol3</code>.</p>"""
    security_style: NotRequired["capo_fsx.types.security_style.SecurityStyle"]
    """<p>The security style for the volume, which can be <code>UNIX</code>, <code>NTFS</code>, or <code>MIXED</code>.</p>"""
    size_in_megabytes: NotRequired["capo_fsx.types.volume_capacity.VolumeCapacity"]
    """<p>Specifies the size of the volume in megabytes.</p>"""
    storage_efficiency_enabled: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>Default is <code>false</code>. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.</p>"""
    tiering_policy: NotRequired["capo_fsx.types.tiering_policy.TieringPolicy"]
    """<p>Update the volume's data tiering policy.</p>"""
    snapshot_policy: NotRequired["capo_fsx.types.snapshot_policy.SnapshotPolicy"]
    """<p>Specifies the snapshot policy for the volume. There are three built-in snapshot policies:</p> <ul> <li> <p> <code>default</code>: 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.</p> </li> <li> <p> <code>default-1weekly</code>: This policy is the same as the <code>default</code> policy except that it only retains one snapshot from the weekly schedule.</p> </li> <li> <p> <code>none</code>: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.</p> </li> </ul> <p>You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies">Snapshot policies</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>"""
    copy_tags_to_backups: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>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.</p>"""
    snaplock_configuration: NotRequired[
        "capo_fsx.types.update_snaplock_configuration.UpdateSnaplockConfiguration"
    ]
    """<p>The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume. </p>"""
    size_in_bytes: NotRequired[
        "capo_fsx.types.volume_capacity_bytes.VolumeCapacityBytes"
    ]
    """<p>The configured size of the volume, in bytes.</p>"""

copy_tags_to_backups instance-attribute

copy_tags_to_backups: NotRequired[Flag]

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.

junction_path instance-attribute

junction_path: NotRequired[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.

security_style instance-attribute

security_style: NotRequired[SecurityStyle]

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

size_in_bytes instance-attribute

size_in_bytes: NotRequired[VolumeCapacityBytes]

The configured size of the volume, in bytes.

size_in_megabytes instance-attribute

size_in_megabytes: NotRequired[VolumeCapacity]

Specifies the size of the volume in megabytes.

snaplock_configuration instance-attribute

snaplock_configuration: NotRequired[UpdateSnaplockConfiguration]

The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.

snapshot_policy instance-attribute

snapshot_policy: NotRequired[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.

storage_efficiency_enabled instance-attribute

storage_efficiency_enabled: NotRequired[Flag]

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

tiering_policy instance-attribute

tiering_policy: NotRequired[TieringPolicy]

Update the volume's data tiering policy.