Package software.amazon.awscdk.services.fsx

Interface CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnFileSystem
@Stability(Stable) public static interface CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty extends software.amazon.jsii.JsiiSerializable
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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 SelfManagedActiveDirectoryConfigurationProperty selfManagedActiveDirectoryConfigurationProperty = SelfManagedActiveDirectoryConfigurationProperty.builder()
         .dnsIps(List.of("dnsIps"))
         .domainName("domainName")
         .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
         .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
         .password("password")
         .userName("userName")
         .build();

  • Method Details

    • getDnsIps

      @Stability(Stable) @Nullable default List<String> getDnsIps()
      A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

    • getDomainName

      @Stability(Stable) @Nullable default String getDomainName()
      The fully qualified domain name of the self-managed AD directory, such as corp.example.com .

    • getFileSystemAdministratorsGroup

      @Stability(Stable) @Nullable default String getFileSystemAdministratorsGroup()
      (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.

    • getOrganizationalUnitDistinguishedName

      @Stability(Stable) @Nullable default String getOrganizationalUnitDistinguishedName()
      (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.

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

    • getPassword

      @Stability(Stable) @Nullable default String getPassword()
      The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

    • getUserName

      @Stability(Stable) @Nullable default String getUserName()
      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.

    • builder

      @Stability(Stable) static CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty.Builder builder()
      Returns:
      a CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty.Builder of CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty