Struct aws_sdk_fsx::types::WindowsFileSystemConfiguration

#[non_exhaustive]
pub struct WindowsFileSystemConfiguration {

    pub active_directory_id: Option<String>,
    pub self_managed_active_directory_configuration: Option<SelfManagedActiveDirectoryAttributes>,
    pub deployment_type: Option<WindowsDeploymentType>,
    pub remote_administration_endpoint: Option<String>,
    pub preferred_subnet_id: Option<String>,
    pub preferred_file_server_ip: Option<String>,
    pub throughput_capacity: Option<i32>,
    pub maintenance_operations_in_progress: Option<Vec<FileSystemMaintenanceOperation>>,
    pub weekly_maintenance_start_time: Option<String>,
    pub daily_automatic_backup_start_time: Option<String>,
    pub automatic_backup_retention_days: Option<i32>,
    pub copy_tags_to_backups: Option<bool>,
    pub aliases: Option<Vec<Alias>>,
    pub audit_log_configuration: Option<WindowsAuditLogConfiguration>,
    pub disk_iops_configuration: Option<DiskIopsConfiguration>,
}

The configuration for this Microsoft Windows file system.

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.

active_directory_id: Option<String>

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

self_managed_active_directory_configuration: Option<SelfManagedActiveDirectoryAttributes>

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

deployment_type: Option<WindowsDeploymentType>

Specifies the file system deployment type, valid values are the following:

• MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

• SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

• SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems.

remote_administration_endpoint: Option<String>

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

preferred_subnet_id: Option<String>

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

preferred_file_server_ip: Option<String>

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

throughput_capacity: Option<i32>

The throughput of the Amazon FSx file system, measured in megabytes per second.

maintenance_operations_in_progress: Option<Vec<FileSystemMaintenanceOperation>>

The list of maintenance operations in progress for this file system.

weekly_maintenance_start_time: Option<String>

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

daily_automatic_backup_start_time: Option<String>

The preferred time to take daily automatic backups, in the UTC time zone.

automatic_backup_retention_days: Option<i32>

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

copy_tags_to_backups: Option<bool>

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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 file system, regardless of this value.

aliases: Option<Vec<Alias>>

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

audit_log_configuration: Option<WindowsAuditLogConfiguration>

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

disk_iops_configuration: Option<DiskIopsConfiguration>

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

Implementations

impl WindowsFileSystemConfiguration

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

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

pub fn self_managed_active_directory_configuration( &self ) -> Option<&SelfManagedActiveDirectoryAttributes>

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

pub fn deployment_type(&self) -> Option<&WindowsDeploymentType>

Specifies the file system deployment type, valid values are the following:

• MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

• SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

• SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

For more information, see Single-AZ and Multi-AZ File Systems.

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

For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

This endpoint is temporarily unavailable when the file system is undergoing maintenance.

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

For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

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

For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

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

The throughput of the Amazon FSx file system, measured in megabytes per second.

pub fn maintenance_operations_in_progress( &self ) -> &[FileSystemMaintenanceOperation]

The list of maintenance operations in progress for this file system.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .maintenance_operations_in_progress.is_none().

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

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

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

The preferred time to take daily automatic backups, in the UTC time zone.

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

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

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

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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 file system, regardless of this value.

pub fn aliases(&self) -> &[Alias]

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .aliases.is_none().

pub fn audit_log_configuration(&self) -> Option<&WindowsAuditLogConfiguration>

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

pub fn disk_iops_configuration(&self) -> Option<&DiskIopsConfiguration>

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

impl WindowsFileSystemConfiguration

pub fn builder() -> WindowsFileSystemConfigurationBuilder

Creates a new builder-style object to manufacture WindowsFileSystemConfiguration.

Trait Implementations

impl Clone for WindowsFileSystemConfiguration

fn clone(&self) -> WindowsFileSystemConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowsFileSystemConfiguration

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

Formats the value using the given formatter.

impl PartialEq for WindowsFileSystemConfiguration

fn eq(&self, other: &WindowsFileSystemConfiguration) -> 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 WindowsFileSystemConfiguration