Struct aws_sdk_fsx::types::builders::OntapVolumeConfigurationBuilder

#[non_exhaustive]
pub struct OntapVolumeConfigurationBuilder { /* private fields */ }

A builder for OntapVolumeConfiguration.

Implementations

impl OntapVolumeConfigurationBuilder

pub fn flex_cache_endpoint_type(self, input: FlexCacheEndpointType) -> Self

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

• NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

• ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

• CACHE specifies that the volume is a FlexCache volume.

pub fn set_flex_cache_endpoint_type( self, input: Option<FlexCacheEndpointType> ) -> Self

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

• NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

• ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

• CACHE specifies that the volume is a FlexCache volume.

pub fn get_flex_cache_endpoint_type(&self) -> &Option<FlexCacheEndpointType>

Specifies the FlexCache endpoint type of the volume. Valid values are the following:

• NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

• ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

• CACHE specifies that the volume is a FlexCache volume.

pub fn junction_path(self, input: impl Into<String>) -> Self

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

pub fn set_junction_path(self, input: Option<String>) -> Self

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

pub fn get_junction_path(&self) -> &Option<String>

Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

pub fn security_style(self, input: SecurityStyle) -> Self

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

pub fn set_security_style(self, input: Option<SecurityStyle>) -> Self

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

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

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

pub fn size_in_megabytes(self, input: i32) -> Self

The configured size of the volume, in megabytes (MBs).

pub fn set_size_in_megabytes(self, input: Option<i32>) -> Self

The configured size of the volume, in megabytes (MBs).

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

The configured size of the volume, in megabytes (MBs).

pub fn storage_efficiency_enabled(self, input: bool) -> Self

The volume's storage efficiency setting.

pub fn set_storage_efficiency_enabled(self, input: Option<bool>) -> Self

The volume's storage efficiency setting.

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

The volume's storage efficiency setting.

pub fn storage_virtual_machine_id(self, input: impl Into<String>) -> Self

The ID of the volume's storage virtual machine.

pub fn set_storage_virtual_machine_id(self, input: Option<String>) -> Self

The ID of the volume's storage virtual machine.

pub fn get_storage_virtual_machine_id(&self) -> &Option<String>

The ID of the volume's storage virtual machine.

pub fn storage_virtual_machine_root(self, input: bool) -> Self

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

pub fn set_storage_virtual_machine_root(self, input: Option<bool>) -> Self

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

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

A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

pub fn tiering_policy(self, input: TieringPolicy) -> Self

The volume's TieringPolicy setting.

pub fn set_tiering_policy(self, input: Option<TieringPolicy>) -> Self

The volume's TieringPolicy setting.

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

The volume's TieringPolicy setting.

pub fn uuid(self, input: impl Into<String>) -> Self

The volume's universally unique identifier (UUID).

pub fn set_uuid(self, input: Option<String>) -> Self

The volume's universally unique identifier (UUID).

pub fn get_uuid(&self) -> &Option<String>

The volume's universally unique identifier (UUID).

pub fn ontap_volume_type(self, input: OntapVolumeType) -> Self

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

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

• DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

• LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

pub fn set_ontap_volume_type(self, input: Option<OntapVolumeType>) -> Self

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

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

• DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

• LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

pub fn get_ontap_volume_type(&self) -> &Option<OntapVolumeType>

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

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

• DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

• LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

pub fn snapshot_policy(self, input: impl Into<String>) -> Self

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 set_snapshot_policy(self, input: Option<String>) -> Self

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 get_snapshot_policy(&self) -> &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.

pub fn copy_tags_to_backups(self, input: bool) -> Self

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 set_copy_tags_to_backups(self, input: Option<bool>) -> Self

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 get_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, input: SnaplockConfiguration) -> Self

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

pub fn set_snaplock_configuration( self, input: Option<SnaplockConfiguration> ) -> Self

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

pub fn get_snaplock_configuration(&self) -> &Option<SnaplockConfiguration>

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

pub fn volume_style(self, input: VolumeStyle) -> Self

Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

pub fn set_volume_style(self, input: Option<VolumeStyle>) -> Self

Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

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

Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

pub fn aggregate_configuration(self, input: AggregateConfiguration) -> Self

This structure specifies configuration options for a volume’s storage aggregate or aggregates.

pub fn set_aggregate_configuration( self, input: Option<AggregateConfiguration> ) -> Self

This structure specifies configuration options for a volume’s storage aggregate or aggregates.

pub fn get_aggregate_configuration(&self) -> &Option<AggregateConfiguration>

This structure specifies configuration options for a volume’s storage aggregate or aggregates.

pub fn size_in_bytes(self, input: i64) -> Self

The configured size of the volume, in bytes.

pub fn set_size_in_bytes(self, input: Option<i64>) -> Self

The configured size of the volume, in bytes.

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

The configured size of the volume, in bytes.

pub fn build(self) -> OntapVolumeConfiguration

Consumes the builder and constructs a OntapVolumeConfiguration.

Trait Implementations

impl Clone for OntapVolumeConfigurationBuilder

fn clone(&self) -> OntapVolumeConfigurationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OntapVolumeConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for OntapVolumeConfigurationBuilder

fn default() -> OntapVolumeConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for OntapVolumeConfigurationBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for OntapVolumeConfigurationBuilder