Interface SelfManagedActiveDirectoryConfiguration.Builder

  • Method Details

    • domainName

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

      Parameters:
      domainName - The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • organizationalUnitDistinguishedName

      SelfManagedActiveDirectoryConfiguration.Builder organizationalUnitDistinguishedName(String 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.

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

      Parameters:
      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • fileSystemAdministratorsGroup

      SelfManagedActiveDirectoryConfiguration.Builder fileSystemAdministratorsGroup(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • password

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

      Parameters:
      password - The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dnsIps

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

      Parameters:
      dnsIps - A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dnsIps

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

      Parameters:
      dnsIps - A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • domainJoinServiceAccountSecret

      SelfManagedActiveDirectoryConfiguration.Builder domainJoinServiceAccountSecret(String domainJoinServiceAccountSecret)

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. 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.

      Parameters:
      domainJoinServiceAccountSecret - The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.