CreateOntapVolumeConfiguration ¶

class CreateOntapVolumeConfiguration(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. This parameter is required. 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>Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:</p> <ul> <li> <p> <code>UNIX</code> if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. </p> </li> <li> <p> <code>NTFS</code> if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.</p> </li> <li> <p> <code>MIXED</code> This is an advanced setting. For more information, see the topic <a href="https://docs.netapp.com/us-en/ontap/nfs-admin/security-styles-their-effects-concept.html">What the security styles and their effects are</a> in the NetApp Documentation Center.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-security-style">Volume security style</a> in the FSx for ONTAP User Guide.</p>"""
    size_in_megabytes: NotRequired["capo_fsx.types.volume_capacity.VolumeCapacity"]
    """<p>Use <code>SizeInBytes</code> instead. Specifies the size of the volume, in megabytes (MB), that you are creating.</p>"""
    storage_efficiency_enabled: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.</p> <p> <code>StorageEfficiencyEnabled</code> is required when creating a <code>RW</code> volume (<code>OntapVolumeType</code> set to <code>RW</code>).</p>"""
    storage_virtual_machine_id: NotRequired[
        "capo_fsx.types.storage_virtual_machine_id.StorageVirtualMachineId"
    ]
    """<p>Specifies the ONTAP SVM in which to create the volume.</p>"""
    tiering_policy: NotRequired["capo_fsx.types.tiering_policy.TieringPolicy"]
    ontap_volume_type: NotRequired[
        "capo_fsx.types.input_ontap_volume_type.InputOntapVolumeType"
    ]
    """<p>Specifies the type of volume you are creating. Valid values are the following:</p> <ul> <li> <p> <code>RW</code> specifies a read/write volume. <code>RW</code> is the default.</p> </li> <li> <p> <code>DP</code> specifies a data-protection volume. A <code>DP</code> volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-types">Volume types</a> in the Amazon FSx for NetApp ONTAP User Guide.</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 Amazon FSx for NetApp ONTAP User Guide.</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.create_snaplock_configuration.CreateSnaplockConfiguration"
    ]
    """<p>Specifies the SnapLock configuration for an FSx for ONTAP volume. </p>"""
    volume_style: NotRequired["capo_fsx.types.volume_style.VolumeStyle"]
    """<p>Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html#volume-styles">Volume styles</a> in the Amazon FSx for NetApp ONTAP User Guide.</p>"""
    aggregate_configuration: NotRequired[
        "capo_fsx.types.create_aggregate_configuration.CreateAggregateConfiguration"
    ]
    """<p>Use to specify configuration options for a volume’s storage aggregate or aggregates.</p>"""
    size_in_bytes: NotRequired[
        "capo_fsx.types.volume_capacity_bytes.VolumeCapacityBytes"
    ]
    """<p>Specifies the configured size of the volume, in bytes.</p>"""