WindowsFileSystemState class
Input properties used for looking up and filtering WindowsFileSystem resources.
Constructors
-
WindowsFileSystemState({Input<
String?> ? activeDirectoryId, Input<List< ? aliases, Input<String> ?>String?> ? arn, Input<WindowsFileSystemAuditLogConfiguration?> ? auditLogConfiguration, Input<int?> ? automaticBackupRetentionDays, Input<String?> ? backupId, Input<bool?> ? copyTagsToBackups, Input<String?> ? dailyAutomaticBackupStartTime, Input<String?> ? deploymentType, Input<WindowsFileSystemDiskIopsConfiguration?> ? diskIopsConfiguration, Input<String?> ? dnsName, Input<Map< ? finalBackupTags, Input<String, String> ?>String?> ? kmsKeyId, Input<List< ? networkInterfaceIds, Input<String> ?>String?> ? networkType, Input<String?> ? ownerId, Input<String?> ? preferredFileServerIp, Input<String?> ? preferredSubnetId, Input<String?> ? region, Input<String?> ? remoteAdministrationEndpoint, Input<List< ? securityGroupIds, Input<String> ?>WindowsFileSystemSelfManagedActiveDirectory?> ? selfManagedActiveDirectory, Input<bool?> ? skipFinalBackup, Input<int?> ? storageCapacity, Input<String?> ? storageType, Input<List< ? subnetIds, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>int?> ? throughputCapacity, Input<String?> ? vpcId, Input<String?> ? weeklyMaintenanceStartTime}) -
Creates a new WindowsFileSystemState.
activeDirectoryIdID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified withselfManagedActiveDirectory.aliasesArray DNS alias names that you want to associate with the Amazon FSx file system. For more information, see Working with DNS AliasesarnARN of the file system.auditLogConfigurationConfiguration 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. SeeauditLogConfigurationBlock for details.automaticBackupRetentionDaysNumber of days to retain automatic backups. Minimum of0and maximum of90. Defaults to7. Set to0to disable.backupIdID of the source backup to create the filesystem from.copyTagsToBackupsWhether to copy tags on the file system to backups. Defaults tofalse.dailyAutomaticBackupStartTimePreferred time (inHH:MMformat) to take daily automatic backups, in the UTC time zone.deploymentTypeFile system deployment type. Valid values areMULTI_AZ_1,SINGLE_AZ_1andSINGLE_AZ_2. Default value isSINGLE_AZ_1.diskIopsConfigurationSSD IOPS configuration for the Amazon FSx for Windows File Server file system. SeediskIopsConfigurationBlock for details.dnsNameDNS name for the file system, e.g.,fs-12345678.corp.example.com(domain name matching the Active Directory domain name)finalBackupTagsMap of tags to apply to the file system's final backup.kmsKeyIdARN for the KMS Key to encrypt the file system at rest. Defaults to an AWS managed KMS Key.networkInterfaceIdsSet of Elastic Network Interface identifiers from which the file system is accessible.networkTypeNetwork type. Valid values areIPV4andDUAL. Default value isIPV4.ownerIdAWS account identifier that created the file system.preferredFileServerIpIP address of the primary, or preferred, file server.preferredSubnetIdSubnet in which you want the preferred file server to be located. Required for when deployment type isMULTI_AZ_1.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.remoteAdministrationEndpointForMULTI_AZ_1deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. ForSINGLE_AZ_1deployment types, this is the DNS name of the file system.securityGroupIdsList 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.selfManagedActiveDirectoryConfiguration 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 withactiveDirectoryId. SeeselfManagedActiveDirectoryBlock for details.skipFinalBackupWhen 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 tofalse.storageCapacityStorage capacity (GiB) of the file system. Minimum of 32 and maximum of 65536. If the storage type is set toHDDthe minimum value is 2000. Required when not creating filesystem for a backup.storageTypeStorage type. Valid values areSSDandHDD.HDDis supported onSINGLE_AZ_2andMULTI_AZ_1Windows file system deployment types. Default value isSSD.subnetIdsList of IDs for the subnets that the file system will be accessible from. To specify more than a single subnet setdeploymentTypetoMULTI_AZ_1.tagsMap of tags to assign to the file system. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.throughputCapacityThroughput (megabytes per second) of the file system. For valid values, refer to the AWS documentation.vpcIdIdentifier of the VPC for the file system.weeklyMaintenanceStartTimePreferred start time (ind:HH:MMformat) to perform weekly maintenance, in the UTC time zone.const -
WindowsFileSystemState.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
-
arn
→ Input<
String?> ? -
ARN of the file system.
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
auditLogConfigurationBlock for details.final -
automaticBackupRetentionDays
→ Input<
int?> ? -
Number of days to retain automatic backups. Minimum of
0and maximum of90. Defaults to7. Set to0to 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:MMformat) 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_1andSINGLE_AZ_2. Default value isSINGLE_AZ_1.final -
diskIopsConfiguration
→ Input<
WindowsFileSystemDiskIopsConfiguration?> ? -
SSD IOPS configuration for the Amazon FSx for Windows File Server file system. See
diskIopsConfigurationBlock for details.final -
dnsName
→ Input<
String?> ? -
DNS name for the file system, e.g.,
fs-12345678.corp.example.com(domain name matching the Active Directory domain name)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
-
networkInterfaceIds
→ Input<
List< ?String> ?> -
Set of Elastic Network Interface identifiers from which the file system is accessible.
final
-
networkType
→ Input<
String?> ? -
Network type. Valid values are
IPV4andDUAL. Default value isIPV4.final -
ownerId
→ Input<
String?> ? -
AWS account identifier that created the file system.
final
-
preferredFileServerIp
→ Input<
String?> ? -
IP address of the primary, or preferred, file server.
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
-
remoteAdministrationEndpoint
→ Input<
String?> ? -
For
MULTI_AZ_1deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. ForSINGLE_AZ_1deployment types, this is the DNS name of the file system.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. SeeselfManagedActiveDirectoryBlock 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
HDDthe minimum value is 2000. Required when not creating filesystem for a backup.final -
storageType
→ Input<
String?> ? -
Storage type. Valid values are
SSDandHDD.HDDis supported onSINGLE_AZ_2andMULTI_AZ_1Windows file system deployment types. Default value isSSD.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
deploymentTypetoMULTI_AZ_1.final -
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
throughputCapacity
→ Input<
int?> ? -
Throughput (megabytes per second) of the file system. For valid values, refer to the AWS documentation.
final
-
vpcId
→ Input<
String?> ? -
Identifier of the VPC for the file system.
final
-
weeklyMaintenanceStartTime
→ Input<
String?> ? -
Preferred start time (in
d:HH:MMformat) 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