Package software.amazon.awssdk.services.opensearch.model

Class IAMFederationOptionsInput

java.lang.Object

software.amazon.awssdk.services.opensearch.model.IAMFederationOptionsInput

All Implemented Interfaces:

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

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

Input parameters for configuring IAM identity federation settings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IAMFederationOptionsInput.Builder

Method Summary

Modifier and Type	Method	Description
static IAMFederationOptionsInput.Builder	builder()
Boolean	enabled()	Specifies whether IAM identity federation is enabled for the OpenSearch domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	rolesKey()	The key in the SAML assertion that contains the user's role information.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IAMFederationOptionsInput.Builder>	serializableBuilderClass()
String	subjectKey()	The key in the SAML assertion that contains the user's subject identifier.
IAMFederationOptionsInput.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

enabled

public final Boolean enabled()

Specifies whether IAM identity federation is enabled for the OpenSearch domain.

Returns:

Specifies whether IAM identity federation is enabled for the OpenSearch domain.

subjectKey

public final String subjectKey()

The key in the SAML assertion that contains the user's subject identifier.

Returns:

The key in the SAML assertion that contains the user's subject identifier.

rolesKey

public final String rolesKey()

The key in the SAML assertion that contains the user's role information.

Returns:

The key in the SAML assertion that contains the user's role information.

toBuilder

public IAMFederationOptionsInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IAMFederationOptionsInput.Builder,IAMFederationOptionsInput>

builder

public static IAMFederationOptionsInput.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo