com.amazonaws.services.fsx.model

Class SelfManagedActiveDirectoryConfiguration

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SelfManagedActiveDirectoryConfiguration()

Method Summary

Modifier and Type	Method and Description
SelfManagedActiveDirectoryConfiguration	clone()
boolean	equals(Object obj)
List<String>	getDnsIps() A list of up to three 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.
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) Marshalls this structured data using the given ProtocolMarshaller.
void	setDnsIps(Collection<String> dnsIps) A list of up to three 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.
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 three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
SelfManagedActiveDirectoryConfiguration	withDnsIps(String... dnsIps) A list of up to three 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.
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

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

getOrganizationalUnitDistinguishedName

public 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.

Returns:

(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.

withOrganizationalUnitDistinguishedName

public SelfManagedActiveDirectoryConfiguration withOrganizationalUnitDistinguishedName(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.

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 three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

Returns:

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

setDnsIps

public void setDnsIps(Collection<String> 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.

withDnsIps

public SelfManagedActiveDirectoryConfiguration withDnsIps(String... dnsIps)

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

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

withDnsIps

public SelfManagedActiveDirectoryConfiguration withDnsIps(Collection<String> 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.

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)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.