Class SelfManagedActiveDirectoryConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
dnsIps()
A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.final String
The fully qualified domain name of the self-managed AD directory, such ascorp.example.com
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
(Optional) The name of the domain group whose members are granted administrative privileges for the file system.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DnsIps property.final int
hashCode()
final String
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory.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.static Class
<? extends SelfManagedActiveDirectoryConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
(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
(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
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SelfManagedActiveDirectoryConfiguration.Builder,
SelfManagedActiveDirectoryConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SelfManagedActiveDirectoryConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-