SelfManagedActiveDirectoryConfiguration (AWS Java SDK for Amazon FSx 1.11.825 API)

java.lang.Object
- com.amazonaws.services.fsx.model.SelfManagedActiveDirectoryConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SelfManagedActiveDirectoryConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SelfManagedActiveDirectoryConfiguration()

Constructors
Constructor and Description
`SelfManagedActiveDirectoryConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SelfManagedActiveDirectoryConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getDnsIps()` A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
`String`	`getDomainName()` The fully qualified domain name of the self-managed AD directory, such as `corp.example.com`.
`String`	`getFileSystemAdministratorsGroup()` (Optional) The name of the domain group whose members are granted administrative privileges for the file system.
`String`	`getOrganizationalUnitDistinguishedName()` (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join.
`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.
`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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDnsIps(Collection<String> dnsIps)` A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
`void`	`setDomainName(String domainName)` The fully qualified domain name of the self-managed AD directory, such as `corp.example.com`.
`void`	`setFileSystemAdministratorsGroup(String fileSystemAdministratorsGroup)` (Optional) The name of the domain group whose members are granted administrative privileges for the file system.
`void`	`setOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName)` (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join.
`void`	`setPassword(String password)` The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
`void`	`setUserName(String 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.
`String`	`toString()` Returns a string representation of this object.
`SelfManagedActiveDirectoryConfiguration`	`withDnsIps(Collection<String> dnsIps)` A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
`SelfManagedActiveDirectoryConfiguration`	`withDnsIps(String... dnsIps)` A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
`SelfManagedActiveDirectoryConfiguration`	`withDomainName(String domainName)` The fully qualified domain name of the self-managed AD directory, such as `corp.example.com`.
`SelfManagedActiveDirectoryConfiguration`	`withFileSystemAdministratorsGroup(String fileSystemAdministratorsGroup)` (Optional) The name of the domain group whose members are granted administrative privileges for the file system.
`SelfManagedActiveDirectoryConfiguration`	`withOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName)` (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join.
`SelfManagedActiveDirectoryConfiguration`	`withPassword(String password)` The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
`SelfManagedActiveDirectoryConfiguration`	`withUserName(String 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.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SelfManagedActiveDirectoryConfiguration
```
public SelfManagedActiveDirectoryConfiguration()
```
- Method Detail
  - setDomainName
```
public void setDomainName(String 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.
  - getDomainName
```
public String getDomainName()
```
    The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
    
    Returns:
    
    The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
  - withDomainName
```
public SelfManagedActiveDirectoryConfiguration withDomainName(String 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.
  - setOrganizationalUnitDistinguishedName
```
public void setOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName)
```
    (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. 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 that the Windows File Server instance will join. 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.
  - getOrganizationalUnitDistinguishedName
```
public String getOrganizationalUnitDistinguishedName()
```
    (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. 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:
    
    (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. 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.
  - withOrganizationalUnitDistinguishedName
```
public SelfManagedActiveDirectoryConfiguration withOrganizationalUnitDistinguishedName(String organizationalUnitDistinguishedName)
```
    (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. 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 that the Windows File Server instance will join. 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.
  - setFileSystemAdministratorsGroup
```
public void setFileSystemAdministratorsGroup(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.
  - getFileSystemAdministratorsGroup
```
public 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.
    
    Returns:
    
    (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.
  - withFileSystemAdministratorsGroup
```
public SelfManagedActiveDirectoryConfiguration withFileSystemAdministratorsGroup(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.
  - setUserName
```
public void setUserName(String 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.
  - getUserName
```
public 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.
    
    Returns:
    
    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.
  - withUserName
```
public SelfManagedActiveDirectoryConfiguration withUserName(String 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.
  - setPassword
```
public void setPassword(String 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.
  - getPassword
```
public 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.
    
    Returns:
    
    The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
  - withPassword
```
public SelfManagedActiveDirectoryConfiguration withPassword(String 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.
  - getDnsIps
```
public List<String> getDnsIps()
```
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    - 10.0.0.0 - 10.255.255.255 (10/8 prefix)
    - 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    - 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    Returns:
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    
    10.0.0.0 - 10.255.255.255 (10/8 prefix)
    
    172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    
    192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
  - setDnsIps
```
public void setDnsIps(Collection<String> dnsIps)
```
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    - 10.0.0.0 - 10.255.255.255 (10/8 prefix)
    - 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    - 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    Parameters:
    dnsIps - A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    
    10.0.0.0 - 10.255.255.255 (10/8 prefix)
    
    172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    
    192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
  - withDnsIps
```
public SelfManagedActiveDirectoryConfiguration withDnsIps(String... dnsIps)
```
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    - 10.0.0.0 - 10.255.255.255 (10/8 prefix)
    - 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    - 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    NOTE: This method appends the values to the existing list (if any). Use setDnsIps(java.util.Collection) or withDnsIps(java.util.Collection) if you want to override the existing values.
    Parameters:
    dnsIps - A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    
    10.0.0.0 - 10.255.255.255 (10/8 prefix)
    
    172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    
    192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDnsIps
```
public SelfManagedActiveDirectoryConfiguration withDnsIps(Collection<String> dnsIps)
```
    A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    - 10.0.0.0 - 10.255.255.255 (10/8 prefix)
    - 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    - 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    Parameters:
    dnsIps - A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
    
    10.0.0.0 - 10.255.255.255 (10/8 prefix)
    
    172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    
    192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SelfManagedActiveDirectoryConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SelfManagedActiveDirectoryConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SelfManagedActiveDirectoryConfiguration

Method Detail

setDomainName

getDomainName

withDomainName

setOrganizationalUnitDistinguishedName

getOrganizationalUnitDistinguishedName

withOrganizationalUnitDistinguishedName

setFileSystemAdministratorsGroup

getFileSystemAdministratorsGroup

withFileSystemAdministratorsGroup

setUserName

getUserName

withUserName

setPassword

getPassword

withPassword

getDnsIps

setDnsIps

withDnsIps

withDnsIps

toString

equals

hashCode

clone

marshall