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. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.
Contents
- DnsIps
-
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Length Constraints: Minimum length of 7. Maximum length of 15.
Pattern:
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$Required: Yes
- DomainName
-
The fully qualified domain name of the self-managed AD directory, such as
corp.example.com.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$Required: Yes
- Password
-
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^.{1,256}$Required: Yes
- UserName
-
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in
OrganizationalUnitDistinguishedName, or in the default location of your AD domain.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,256}$Required: Yes
- FileSystemAdministratorsGroup
-
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,256}$Required: No
- OrganizationalUnitDistinguishedName
-
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is
OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Important
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,2000}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
