WindowsConfigurationProperty Struct
The Microsoft Windows configuration for the file system that's being created.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const windowsConfigurationProperty: fsx.CfnFileSystem.WindowsConfigurationProperty = {
throughputCapacity: 123,
// the properties below are optional
activeDirectoryId: 'activeDirectoryId',
aliases: ['aliases'],
auditLogConfiguration: {
fileAccessAuditLogLevel: 'fileAccessAuditLogLevel',
fileShareAccessAuditLogLevel: 'fileShareAccessAuditLogLevel',
// the properties below are optional
auditLogDestination: 'auditLogDestination',
},
automaticBackupRetentionDays: 123,
copyTagsToBackups: false,
dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
deploymentType: 'deploymentType',
diskIopsConfiguration: {
iops: 123,
mode: 'mode',
},
fsrmConfiguration: {
fsrmServiceEnabled: false,
// the properties below are optional
eventLogDestination: 'eventLogDestination',
},
preferredSubnetId: 'preferredSubnetId',
selfManagedActiveDirectoryConfiguration: {
dnsIps: ['dnsIps'],
domainJoinServiceAccountSecret: 'domainJoinServiceAccountSecret',
domainName: 'domainName',
fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
password: 'password',
userName: 'userName',
},
weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
};
Properties
activeDirectoryIdstringactive_directory_idstractiveDirectoryIdStringActiveDirectoryIdstringActiveDirectoryId*string#Required if you are joining the file system to an existing AWS Managed Microsoft AD.
notes
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.
For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system , including additional steps you must take to be able to access your file system using a DNS alias.
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 alphabetical characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
auditLogConfigurationIResolvable | CfnFileSystem.AuditLogConfigurationPropertyaudit_log_configurationtyping.Union[IResolvable, AuditLogConfigurationProperty]auditLogConfigurationIResolvableAuditLogConfigurationIResolvableAuditLogConfigurationinterface{}#automaticBackupRetentionDaysnumberautomatic_backup_retention_daysint | floatautomaticBackupRetentionDaysNumberAutomaticBackupRetentionDaysdoubleAutomaticBackupRetentionDays*float64#Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .
copyTagsToBackupsboolean | IResolvablecopy_tags_to_backupstyping.Union[bool, IResolvable]copyTagsToBackupsBooleanCopyTagsToBackupsboolCopyTagsToBackupsinterface{}#notes
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.
dailyAutomaticBackupStartTimestringdaily_automatic_backup_start_timestrdailyAutomaticBackupStartTimeStringDailyAutomaticBackupStartTimestringDailyAutomaticBackupStartTime*string#HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
deploymentTypestringdeployment_typestrdeploymentTypeStringDeploymentTypestringDeploymentType*string#notes
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 AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage typeSINGLE_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 .
diskIopsConfigurationIResolvable | CfnFileSystem.DiskIopsConfigurationPropertydisk_iops_configurationtyping.Union[IResolvable, DiskIopsConfigurationProperty]diskIopsConfigurationIResolvableDiskIopsConfigurationIResolvableDiskIopsConfigurationinterface{}#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.
fsrmConfigurationIResolvable | CfnFileSystem.FsrmConfigurationPropertyfsrm_configurationtyping.Union[IResolvable, FsrmConfigurationProperty]fsrmConfigurationIResolvableFsrmConfigurationIResolvableFsrmConfigurationinterface{}#preferredSubnetIdstringpreferred_subnet_idstrpreferredSubnetIdStringPreferredSubnetIdstringPreferredSubnetId*string#notes
This specifies the subnet in which you want the preferred file server to be located. For in- AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross-availability zone data transfer costs and minimize latency.
selfManagedActiveDirectoryConfigurationIResolvable | CfnFileSystem.SelfManagedActiveDirectoryConfigurationPropertyself_managed_active_directory_configurationtyping.Union[IResolvable, SelfManagedActiveDirectoryConfigurationProperty]selfManagedActiveDirectoryConfigurationIResolvableSelfManagedActiveDirectoryConfigurationIResolvableSelfManagedActiveDirectoryConfigurationinterface{}#notes
For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .
throughputCapacitynumberthroughput_capacityint | floatthroughputCapacityNumberThroughputCapacitydoubleThroughputCapacity*float64required#To increase storage capacity, a file system must have a minimum throughput capacity of 16 MB/s.
weeklyMaintenanceStartTimestringweekly_maintenance_start_timestrweeklyMaintenanceStartTimeStringWeeklyMaintenanceStartTimestringWeeklyMaintenanceStartTime*string#