Class CfnFileSystem.WindowsConfigurationProperty
The Microsoft Windows configuration for the file system that's being created.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WindowsConfigurationProperty : Object, CfnFileSystem.IWindowsConfigurationProperty
Syntax (vb)
Public Class WindowsConfigurationProperty
Inherits Object
Implements CfnFileSystem.IWindowsConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;
var windowsConfigurationProperty = new WindowsConfigurationProperty {
ThroughputCapacity = 123,
// the properties below are optional
ActiveDirectoryId = "activeDirectoryId",
Aliases = new [] { "aliases" },
AuditLogConfiguration = new AuditLogConfigurationProperty {
FileAccessAuditLogLevel = "fileAccessAuditLogLevel",
FileShareAccessAuditLogLevel = "fileShareAccessAuditLogLevel",
// the properties below are optional
AuditLogDestination = "auditLogDestination"
},
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DeploymentType = "deploymentType",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
PreferredSubnetId = "preferredSubnetId",
SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
DnsIps = new [] { "dnsIps" },
DomainName = "domainName",
FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
Password = "password",
UserName = "userName"
},
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
};
Synopsis
Constructors
WindowsConfigurationProperty() |
Properties
ActiveDirectoryId | The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created. |
Aliases | An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. |
AuditLogConfiguration | 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. |
AutomaticBackupRetentionDays | The number of days to retain automatic backups. |
CopyTagsToBackups | A boolean flag indicating whether tags for the file system should be copied to backups. |
DailyAutomaticBackupStartTime | A recurring daily time, in the format |
DeploymentType | Specifies the file system deployment type, valid values are the following:. |
DiskIopsConfiguration | The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. |
PreferredSubnetId | Required when |
SelfManagedActiveDirectoryConfiguration | The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. |
ThroughputCapacity | Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048). |
WeeklyMaintenanceStartTime | A recurring weekly time, in the format |
Constructors
WindowsConfigurationProperty()
public WindowsConfigurationProperty()
Properties
ActiveDirectoryId
The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
public string ActiveDirectoryId { get; set; }
Property Value
System.String
Remarks
Required if you are joining the file system to an existing AWS Managed Microsoft AD.
Aliases
An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.
public string[] Aliases { get; set; }
Property Value
System.String[]
Remarks
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:
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.
AuditLogConfiguration
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.
public object AuditLogConfiguration { get; set; }
Property Value
System.Object
Remarks
AutomaticBackupRetentionDays
The number of days to retain automatic backups.
public Nullable<double> AutomaticBackupRetentionDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Setting this property to 0
disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30
.
CopyTagsToBackups
A boolean flag indicating whether tags for the file system should be copied to backups.
public object CopyTagsToBackups { get; set; }
Property Value
System.Object
Remarks
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.
DailyAutomaticBackupStartTime
A recurring daily time, in the format HH:MM
.
public string DailyAutomaticBackupStartTime { get; set; }
Property Value
System.String
Remarks
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.
DeploymentType
Specifies the file system deployment type, valid values are the following:.
public string DeploymentType { get; set; }
Property Value
System.String
Remarks
DiskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.
public object DiskIopsConfiguration { get; set; }
Property Value
System.Object
Remarks
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.
PreferredSubnetId
Required when DeploymentType
is set to MULTI_AZ_1
.
public string PreferredSubnetId { get; set; }
Property Value
System.String
Remarks
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.
SelfManagedActiveDirectoryConfiguration
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.
public object SelfManagedActiveDirectoryConfiguration { get; set; }
Property Value
System.Object
Remarks
For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .
ThroughputCapacity
Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).
public double ThroughputCapacity { get; set; }
Property Value
System.Double
Remarks
To increase storage capacity, a file system must have a minimum throughput capacity of 16 MB/s.
WeeklyMaintenanceStartTime
A recurring weekly time, in the format D:HH:MM
.
public string WeeklyMaintenanceStartTime { get; set; }
Property Value
System.String
Remarks
D
is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH
is the zero-padded hour of the day (0-23), and MM
is the zero-padded minute of the hour.
For example, 1:05:00
specifies maintenance at 5 AM Monday.