software.amazon.awssdk.services.directory.model

Class CreateTrustRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.directory.model.DirectoryRequest

software.amazon.awssdk.services.directory.model.CreateTrustRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTrustRequest.Builder,CreateTrustRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTrustRequest
extends DirectoryRequest
implements ToCopyableBuilder<CreateTrustRequest.Builder,CreateTrustRequest>

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTrustRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTrustRequest.Builder	builder()
List<String>	conditionalForwarderIpAddrs() The IP addresses of the remote DNS server associated with RemoteDomainName.
String	directoryId() The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConditionalForwarderIpAddrs() For responses, this returns true if the service returned a value for the ConditionalForwarderIpAddrs property.
int	hashCode()
String	remoteDomainName() The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
List<SdkField<?>>	sdkFields()
SelectiveAuth	selectiveAuth() Optional parameter to enable selective authentication for the trust.
String	selectiveAuthAsString() Optional parameter to enable selective authentication for the trust.
static Class<? extends CreateTrustRequest.Builder>	serializableBuilderClass()
CreateTrustRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TrustDirection	trustDirection() The direction of the trust relationship.
String	trustDirectionAsString() The direction of the trust relationship.
String	trustPassword() The trust password.
TrustType	trustType() The trust relationship type.
String	trustTypeAsString() The trust relationship type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

directoryId

public final String directoryId()

The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

Returns:

The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

remoteDomainName

public final String remoteDomainName()

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

Returns:

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

trustPassword

public final String trustPassword()

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

Returns:

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

trustDirection

public final TrustDirection trustDirection()

The direction of the trust relationship.

If the service returns an enum value that is not available in the current SDK version, trustDirection will return TrustDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trustDirectionAsString().

Returns:

The direction of the trust relationship.

See Also:

TrustDirection

trustDirectionAsString

public final String trustDirectionAsString()

The direction of the trust relationship.

If the service returns an enum value that is not available in the current SDK version, trustDirection will return TrustDirection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trustDirectionAsString().

Returns:

The direction of the trust relationship.

See Also:

TrustDirection

trustType

public final TrustType trustType()

The trust relationship type. Forest is the default.

If the service returns an enum value that is not available in the current SDK version, trustType will return TrustType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trustTypeAsString().

Returns:

The trust relationship type. Forest is the default.

See Also:

TrustType

trustTypeAsString

public final String trustTypeAsString()

The trust relationship type. Forest is the default.

If the service returns an enum value that is not available in the current SDK version, trustType will return TrustType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from trustTypeAsString().

Returns:

The trust relationship type. Forest is the default.

See Also:

TrustType

hasConditionalForwarderIpAddrs

public final boolean hasConditionalForwarderIpAddrs()

For responses, this returns true if the service returned a value for the ConditionalForwarderIpAddrs 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.

conditionalForwarderIpAddrs

public final List<String> conditionalForwarderIpAddrs()

The IP addresses of the remote DNS server associated with RemoteDomainName.

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 hasConditionalForwarderIpAddrs() method.

Returns:

The IP addresses of the remote DNS server associated with RemoteDomainName.

selectiveAuth

public final SelectiveAuth selectiveAuth()

Optional parameter to enable selective authentication for the trust.

If the service returns an enum value that is not available in the current SDK version, selectiveAuth will return SelectiveAuth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectiveAuthAsString().

Returns:

Optional parameter to enable selective authentication for the trust.

See Also:

SelectiveAuth

selectiveAuthAsString

public final String selectiveAuthAsString()

Optional parameter to enable selective authentication for the trust.

If the service returns an enum value that is not available in the current SDK version, selectiveAuth will return SelectiveAuth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectiveAuthAsString().

Returns:

Optional parameter to enable selective authentication for the trust.

See Also:

SelectiveAuth

toBuilder

public CreateTrustRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTrustRequest.Builder,CreateTrustRequest>

Specified by:

toBuilder in class DirectoryRequest

builder

public static CreateTrustRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo