software.amazon.awssdk.services.fsx.model

Class SelfManagedActiveDirectoryConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.SelfManagedActiveDirectoryConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SelfManagedActiveDirectoryConfiguration.Builder,SelfManagedActiveDirectoryConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class SelfManagedActiveDirectoryConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SelfManagedActiveDirectoryConfiguration.Builder,SelfManagedActiveDirectoryConfiguration>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelfManagedActiveDirectoryConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SelfManagedActiveDirectoryConfiguration.Builder	builder()
List<String>	dnsIps() A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
String	domainName() The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemAdministratorsGroup() (Optional) The name of the domain group whose members are granted administrative privileges for the file system.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDnsIps() For responses, this returns true if the service returned a value for the DnsIps property.
int	hashCode()
String	organizationalUnitDistinguishedName() (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends SelfManagedActiveDirectoryConfiguration.Builder>	serializableBuilderClass()
SelfManagedActiveDirectoryConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainName

public final String domainName()

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.

organizationalUnitDistinguishedName

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

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.

fileSystemAdministratorsGroup

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

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.

userName

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

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.

password

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

Returns:

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

hasDnsIps

public final boolean hasDnsIps()

For responses, this returns true if the service returned a value for the DnsIps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

dnsIps

public final List<String> dnsIps()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIps() method.

Returns:

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

toBuilder

public SelfManagedActiveDirectoryConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SelfManagedActiveDirectoryConfiguration.Builder,SelfManagedActiveDirectoryConfiguration>

builder

public static SelfManagedActiveDirectoryConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SelfManagedActiveDirectoryConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo