software.amazon.awssdk.services.rds.model

Class DomainMembership

java.lang.Object

software.amazon.awssdk.services.rds.model.DomainMembership

All Implemented Interfaces:

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

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

An Active Directory Domain membership record associated with the DB instance or cluster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DomainMembership.Builder

Method Summary

Modifier and Type	Method and Description
String	authSecretArn() The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.
static DomainMembership.Builder	builder()
List<String>	dnsIps() The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.
String	domain() The identifier of the Active Directory Domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fqdn() The fully qualified domain name (FQDN) of the Active Directory Domain.
<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	iamRoleName() The name of the IAM role to be used when making API calls to the Directory Service.
String	ou() The Active Directory organizational unit for your DB instance to join.
List<SdkField<?>>	sdkFields()
static Class<? extends DomainMembership.Builder>	serializableBuilderClass()
String	status() The status of the Active Directory Domain membership for the DB instance or cluster.
DomainMembership.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

domain

public final String domain()

The identifier of the Active Directory Domain.

Returns:

The identifier of the Active Directory Domain.

status

public final String status()

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

Returns:

The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

fqdn

public final String fqdn()

The fully qualified domain name (FQDN) of the Active Directory Domain.

Returns:

The fully qualified domain name (FQDN) of the Active Directory Domain.

iamRoleName

public final String iamRoleName()

The name of the IAM role to be used when making API calls to the Directory Service.

Returns:

The name of the IAM role to be used when making API calls to the Directory Service.

ou

public final String ou()

The Active Directory organizational unit for your DB instance to join.

Returns:

The Active Directory organizational unit for your DB instance to join.

authSecretArn

public final String authSecretArn()

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

Returns:

The ARN for the Secrets Manager secret that contains the credentials for the user performing the domain join.

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

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

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:

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

toBuilder

public DomainMembership.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainMembership.Builder,DomainMembership>

builder

public static DomainMembership.Builder builder()

serializableBuilderClass

public static Class<? extends DomainMembership.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