AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon FSx FileSystem WindowsConfiguration

The WindowsConfiguration property type defines an Amazon FSx for Windows File Server file system.

WindowsConfiguration is a property of the AWS::FSx::FileSystem resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax.

JSON

{ "ActiveDirectoryId" : String, "AutomaticBackupRetentionDays" : Integer, "CopyTagsToBackups" : Boolean, "DailyAutomaticBackupStartTime" : String, "ThroughputCapacity" : Integer, "WeeklyMaintenanceStartTime" : String }

Properties

ActiveDirectoryId

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

Length Constraints: Fixed length of 12. Pattern: ^d-[0-9a-f]{10}$

Required: No

Type: String

Update requires: Replacement

AutomaticBackupRetentionDays

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days.

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: Replacement

DailyAutomaticBackupStartTime

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

Length Constraints: Fixed length of 5. Pattern: ^([01]\d|2[0-3]):?([0-5]\d)$

Required: No

Type: String

Update requires: No interruption

ThroughputCapacity

The throughput of an Amazon FSx file system, measured in megabytes per second. Valid range of values: Minimum value of 8. Maximum value of 2048.

Required: No

Type: Integer

Update requires: Replacement

WeeklyMaintenanceStartTime

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

Length Constraints: Fixed length of 7. Pattern: ^[1-7]:([01]\d|2[0-3]):?([0-5]\d)$

Required: No

Type: String

Update requires: No interruption

See Also

On this page: