WindowsFileSystemArgs class

The set of arguments for WindowsFileSystem. The set of arguments for WindowsFileSystem.

Constructors

WindowsFileSystemArgs({Input<String?>? activeDirectoryId, Input<List<String>?>? aliases, Input<WindowsFileSystemAuditLogConfiguration?>? auditLogConfiguration, Input<int?>? automaticBackupRetentionDays, Input<String?>? backupId, Input<bool?>? copyTagsToBackups, Input<String?>? dailyAutomaticBackupStartTime, Input<String?>? deploymentType, Input<WindowsFileSystemDiskIopsConfiguration?>? diskIopsConfiguration, Input<Map<String, String>?>? finalBackupTags, Input<String?>? kmsKeyId, Input<String?>? networkType, Input<String?>? preferredSubnetId, Input<String?>? region, Input<List<String>?>? securityGroupIds, Input<WindowsFileSystemSelfManagedActiveDirectory?>? selfManagedActiveDirectory, Input<bool?>? skipFinalBackup, Input<int?>? storageCapacity, Input<String?>? storageType, required Input<List<String>> subnetIds, Input<Map<String, String>?>? tags, required Input<int> throughputCapacity, Input<String?>? weeklyMaintenanceStartTime})
Creates a new WindowsFileSystemArgs. activeDirectoryId ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with selfManagedActiveDirectory. aliases Array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases auditLogConfiguration 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. See auditLogConfiguration Block for details. automaticBackupRetentionDays Number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable. backupId ID of the source backup to create the filesystem from. copyTagsToBackups Whether to copy tags on the file system to backups. Defaults to false. dailyAutomaticBackupStartTime Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone. deploymentType File system deployment type. Valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1. diskIopsConfiguration SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See diskIopsConfiguration Block for details. finalBackupTags Map of tags to apply to the file system's final backup. kmsKeyId ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key. networkType Network type. Valid values are IPV4 and DUAL. Default value is IPV4. preferredSubnetId Subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. securityGroupIds List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. selfManagedActiveDirectory Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with activeDirectoryId. See selfManagedActiveDirectory Block for details. skipFinalBackup When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false. storageCapacity Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup. storageType Storage type. Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD. subnetIds List of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deploymentType to MULTI_AZ_1. tags Map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. throughputCapacity Throughput (megabytes per second) of the file system. For valid values, refer to the AWS documentation. weeklyMaintenanceStartTime Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
const
WindowsFileSystemArgs.fromMap(Map<String, dynamic> map)
factory

Properties

activeDirectoryId → Input<String?>?
ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with selfManagedActiveDirectory.
final
aliases → Input<List<String>?>?
Array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS Aliases
final
auditLogConfiguration → Input<WindowsFileSystemAuditLogConfiguration?>?
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. See auditLogConfiguration Block for details.
final
automaticBackupRetentionDays → Input<int?>?
Number of days to retain automatic backups. Minimum of 0 and maximum of 90. Defaults to 7. Set to 0 to disable.
final
backupId → Input<String?>?
ID of the source backup to create the filesystem from.
final
copyTagsToBackups → Input<bool?>?
Whether to copy tags on the file system to backups. Defaults to false.
final
dailyAutomaticBackupStartTime → Input<String?>?
Preferred time (in HH:MM format) to take daily automatic backups, in the UTC time zone.
final
deploymentType → Input<String?>?
File system deployment type. Valid values are MULTI_AZ_1, SINGLE_AZ_1 and SINGLE_AZ_2. Default value is SINGLE_AZ_1.
final
diskIopsConfiguration → Input<WindowsFileSystemDiskIopsConfiguration?>?
SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See diskIopsConfiguration Block for details.
final
finalBackupTags → Input<Map<String, String>?>?
Map of tags to apply to the file system's final backup.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
ARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.
final
networkType → Input<String?>?
Network type. Valid values are IPV4 and DUAL. Default value is IPV4.
final
preferredSubnetId → Input<String?>?
Subnet in which you want the preferred file server to be located. Required for when deployment type is MULTI_AZ_1.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
final
selfManagedActiveDirectory → Input<WindowsFileSystemSelfManagedActiveDirectory?>?
Configuration block that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory. Cannot be specified with activeDirectoryId. See selfManagedActiveDirectory Block for details.
final
skipFinalBackup → Input<bool?>?
When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
final
storageCapacity → Input<int?>?
Storage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set to HDD the minimum value is 2000. Required when not creating filesystem for a backup.
final
storageType → Input<String?>?
Storage type. Valid values are SSD and HDD. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. Default value is SSD.
final
subnetIds → Input<List<String>>
List of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet set deploymentType to MULTI_AZ_1.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
throughputCapacity → Input<int>
Throughput (megabytes per second) of the file system. For valid values, refer to the AWS documentation.
final
weeklyMaintenanceStartTime → Input<String?>?
Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited