Amazon FSx
API Reference

WindowsFileSystemConfiguration

The configuration for this Microsoft Windows file system.

Contents

ActiveDirectoryId

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^d-[0-9a-f]{10}$

Required: No

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 35 days.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 35.

Required: No

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.

Type: Boolean

Required: No

DailyAutomaticBackupStartTime

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

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^([01]\d|2[0-3]):?([0-5]\d)$

Required: No

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.

  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy.

Type: String

Valid Values: MULTI_AZ_1 | SINGLE_AZ_1

Required: No

MaintenanceOperationsInProgress

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

Type: Array of strings

Array Members: Maximum number of 20 items.

Valid Values: PATCHING | BACKING_UP

Required: No

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 both SINGLE_AZ_1 and MULTI_AZ_1 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 and instruction on mapping and mounting file shares, see https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html.

Type: String

Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Required: No

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 deployment types, this value is the same as that for SubnetIDs.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-[0-9a-f]{8,})$

Required: No

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 deployment types, this is the DNS name of the file system.

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

Type: String

Length Constraints: Minimum length of 16. Maximum length of 275.

Pattern: ^(fsi?-[0-9a-f]{8,}\..{4,253})$

Required: No

SelfManagedActiveDirectoryConfiguration

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

Type: SelfManagedActiveDirectoryAttributes object

Required: No

ThroughputCapacity

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

Type: Integer

Valid Range: Minimum value of 8. Maximum value of 2048.

Required: No

WeeklyMaintenanceStartTime

The preferred time to perform weekly maintenance, in the UTC time zone.

Type: String

Length Constraints: Fixed length of 7.

Pattern: ^[1-7]:([01]\d|2[0-3]):?([0-5]\d)$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: