aws-cdk-lib.aws_fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty

SelfManagedActiveDirectoryConfigurationProperty Struct

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 .

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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 selfManagedActiveDirectoryConfigurationProperty: fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty = {
  dnsIps: ['dnsIps'],
  domainJoinServiceAccountSecret: 'domainJoinServiceAccountSecret',
  domainName: 'domainName',
  fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
  organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
  password: 'password',
  userName: 'userName',
};

Properties

dnsIpsstring[]dns_ipstyping.List[str]dnsIpsList<String>DnsIpsstring[]DnsIps*[]*string#

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

domainJoinServiceAccountSecretstringdomain_join_service_account_secretstrdomainJoinServiceAccountSecretStringDomainJoinServiceAccountSecretstringDomainJoinServiceAccountSecret*string#

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials.

notes

When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain.

The secret must contain two key-value pairs:

• CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account
• CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory .

domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string#

The fully qualified domain name of the self-managed AD directory, such as `corp.example.com` .

fileSystemAdministratorsGroupstringfile_system_administrators_groupstrfileSystemAdministratorsGroupStringFileSystemAdministratorsGroupstringFileSystemAdministratorsGroup*string#

(Optional) The name of the domain group whose members are granted administrative privileges for the file system.

notes

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.

organizationalUnitDistinguishedNamestringorganizational_unit_distinguished_namestrorganizationalUnitDistinguishedNameStringOrganizationalUnitDistinguishedNamestringOrganizationalUnitDistinguishedName*string#

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory.

notes

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.

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

passwordstringpasswordstrpasswordStringPasswordstringPassword*string#

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

userNamestringuser_namestruserNameStringUserNamestringUserName*string#

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.