Struct CreateOntapVolumeConfiguration

#[non_exhaustive]
pub struct CreateOntapVolumeConfiguration {

    pub junction_path: Option<String>,
    pub security_style: Option<SecurityStyle>,
    pub size_in_megabytes: Option<i32>,
    pub storage_efficiency_enabled: Option<bool>,
    pub storage_virtual_machine_id: Option<String>,
    pub tiering_policy: Option<TieringPolicy>,
    pub ontap_volume_type: Option<InputOntapVolumeType>,
    pub snapshot_policy: Option<String>,
    pub copy_tags_to_backups: Option<bool>,
    pub snaplock_configuration: Option<CreateSnaplockConfiguration>,
    pub volume_style: Option<VolumeStyle>,
    pub aggregate_configuration: Option<CreateAggregateConfiguration>,
    pub size_in_bytes: Option<i64>,
}

Specifies the configuration of the ONTAP volume that you are creating.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

junction_path: Option<String>

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

security_style: Option<SecurityStyle>

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:

• UNIX 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.

• NTFS 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.

• MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

For more information, see Volume security style in the FSx for ONTAP User Guide.

size_in_megabytes: Option<i32>

👎Deprecated: This property is deprecated, use SizeInBytes instead

Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.

storage_efficiency_enabled: Option<bool>

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).

storage_virtual_machine_id: Option<String>

Specifies the ONTAP SVM in which to create the volume.

tiering_policy: Option<TieringPolicy>

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

ontap_volume_type: Option<InputOntapVolumeType>

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

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

• DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

snapshot_policy: Option<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.

copy_tags_to_backups: Option<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.

snaplock_configuration: Option<CreateSnaplockConfiguration>

Specifies the SnapLock configuration for an FSx for ONTAP volume.

volume_style: Option<VolumeStyle>

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 Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

aggregate_configuration: Option<CreateAggregateConfiguration>

Use to specify configuration options for a volume’s storage aggregate or aggregates.

size_in_bytes: Option<i64>

Specifies the configured size of the volume, in bytes.

Implementations

impl CreateOntapVolumeConfiguration

pub fn junction_path(&self) -> Option<&str>

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

pub fn security_style(&self) -> Option<&SecurityStyle>

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:

• UNIX 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.

• NTFS 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.

• MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.

For more information, see Volume security style in the FSx for ONTAP User Guide.

pub fn size_in_megabytes(&self) -> Option<i32>

👎Deprecated: This property is deprecated, use SizeInBytes instead

Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.

pub fn storage_efficiency_enabled(&self) -> Option<bool>

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.

StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).

pub fn storage_virtual_machine_id(&self) -> Option<&str>

Specifies the ONTAP SVM in which to create the volume.

pub fn tiering_policy(&self) -> Option<&TieringPolicy>

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.

• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

pub fn ontap_volume_type(&self) -> Option<&InputOntapVolumeType>

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

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

• DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.

For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.

pub fn snapshot_policy(&self) -> Option<&str>

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.

pub fn copy_tags_to_backups(&self) -> Option<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.

pub fn snaplock_configuration(&self) -> Option<&CreateSnaplockConfiguration>

Specifies the SnapLock configuration for an FSx for ONTAP volume.

pub fn volume_style(&self) -> Option<&VolumeStyle>

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 Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

pub fn aggregate_configuration(&self) -> Option<&CreateAggregateConfiguration>

Use to specify configuration options for a volume’s storage aggregate or aggregates.

pub fn size_in_bytes(&self) -> Option<i64>

Specifies the configured size of the volume, in bytes.

impl CreateOntapVolumeConfiguration

pub fn builder() -> CreateOntapVolumeConfigurationBuilder

Creates a new builder-style object to manufacture CreateOntapVolumeConfiguration.

Trait Implementations

impl Clone for CreateOntapVolumeConfiguration

fn clone(&self) -> CreateOntapVolumeConfiguration

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateOntapVolumeConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateOntapVolumeConfiguration

fn eq(&self, other: &CreateOntapVolumeConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateOntapVolumeConfiguration