CreateFileSystemWindowsConfiguration
¶
Used by
Source code in docs_src/capo_fsx/types/create_file_system_windows_configuration.py
active_directory_id
instance-attribute
¶
active_directory_id: NotRequired[DirectoryId]
The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
aliases
instance-attribute
¶
aliases: NotRequired[AlternateDNSNames]
An array of one or more DNS alias names that you want to associate 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 Managing DNS aliases and Accessing data using DNS aliases.
An alias name has to meet the following requirements:
-
Formatted as a fully-qualified domain name (FQDN),
hostname.domain, for example,accounting.example.com. -
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
-
Cannot start or end with a hyphen.
-
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
audit_log_configuration
instance-attribute
¶
audit_log_configuration: NotRequired[WindowsAuditLogCreateConfiguration]
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.
automatic_backup_retention_days
instance-attribute
¶
automatic_backup_retention_days: NotRequired[AutomaticBackupRetentionDays]
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
copy_tags_to_backups
instance-attribute
¶
copy_tags_to_backups: NotRequired[Flag]
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system 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 file system, regardless of this value.
daily_automatic_backup_start_time
instance-attribute
¶
daily_automatic_backup_start_time: NotRequired[DailyTime]
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
deployment_type
instance-attribute
¶
deployment_type: NotRequired[WindowsDeploymentType]
Specifies the file system deployment type, valid values are the following:
-
MULTI_AZ_1- Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type -
SINGLE_AZ_1- (Default) Choose to deploy a file system that is configured for single AZ redundancy. -
SINGLE_AZ_2- The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
disk_iops_configuration
instance-attribute
¶
disk_iops_configuration: NotRequired[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.
fsrm_configuration
instance-attribute
¶
fsrm_configuration: NotRequired[WindowsFsrmConfiguration]
The File Server Resource Manager (FSRM) configuration that Amazon FSx for Windows File Server uses for the file system. FSRM is disabled by default.
preferred_subnet_id
instance-attribute
¶
preferred_subnet_id: NotRequired[SubnetId]
Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.
self_managed_active_directory_configuration
instance-attribute
¶
self_managed_active_directory_configuration: NotRequired[
SelfManagedActiveDirectoryConfiguration
]
throughput_capacity
instance-attribute
¶
throughput_capacity: NotRequired[MegabytesPerSecond]
Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
weekly_maintenance_start_time
instance-attribute
¶
weekly_maintenance_start_time: NotRequired[WeeklyTime]
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.