Table of Contents

Class WindowsFileSystemConfiguration

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

The configuration for this Microsoft Windows file system.

public class WindowsFileSystemConfiguration
Inheritance
WindowsFileSystemConfiguration
Inherited Members

Constructors

WindowsFileSystemConfiguration()

public WindowsFileSystemConfiguration()

Properties

ActiveDirectoryId

Gets and sets the property ActiveDirectoryId.

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

public string ActiveDirectoryId { get; set; }

Property Value

string

Aliases

Gets and sets the property Aliases.

public List<Alias> Aliases { get; set; }

Property Value

List<Alias>

AuditLogConfiguration

Gets and sets the property AuditLogConfiguration.

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.

public WindowsAuditLogConfiguration AuditLogConfiguration { get; set; }

Property Value

WindowsAuditLogConfiguration

AutomaticBackupRetentionDays

Gets and sets the property AutomaticBackupRetentionDays.

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.

public int AutomaticBackupRetentionDays { get; set; }

Property Value

int

CopyTagsToBackups

Gets and sets the property CopyTagsToBackups.

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.

public bool CopyTagsToBackups { get; set; }

Property Value

bool

DailyAutomaticBackupStartTime

Gets and sets the property DailyAutomaticBackupStartTime.

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

public string DailyAutomaticBackupStartTime { get; set; }

Property Value

string

DeploymentType

Gets and sets the property DeploymentType.

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.

public WindowsDeploymentType DeploymentType { get; set; }

Property Value

WindowsDeploymentType

DiskIopsConfiguration

Gets and sets the property 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.

public DiskIopsConfiguration DiskIopsConfiguration { get; set; }

Property Value

DiskIopsConfiguration

MaintenanceOperationsInProgress

Gets and sets the property MaintenanceOperationsInProgress.

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

public List<string> MaintenanceOperationsInProgress { get; set; }

Property Value

List<string>

PreferredFileServerIp

Gets and sets the property PreferredFileServerIp.

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.

public string PreferredFileServerIp { get; set; }

Property Value

string

PreferredSubnetId

Gets and sets the property PreferredSubnetId.

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.

public string PreferredSubnetId { get; set; }

Property Value

string

RemoteAdministrationEndpoint

Gets and sets the property RemoteAdministrationEndpoint.

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.

public string RemoteAdministrationEndpoint { get; set; }

Property Value

string

SelfManagedActiveDirectoryConfiguration

Gets and sets the property SelfManagedActiveDirectoryConfiguration.

public SelfManagedActiveDirectoryAttributes SelfManagedActiveDirectoryConfiguration { get; set; }

Property Value

SelfManagedActiveDirectoryAttributes

ThroughputCapacity

Gets and sets the property ThroughputCapacity.

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

public int ThroughputCapacity { get; set; }

Property Value

int

WeeklyMaintenanceStartTime

Gets and sets the property WeeklyMaintenanceStartTime.

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.

public string WeeklyMaintenanceStartTime { get; set; }

Property Value

string