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

Class CognitoOptions

java.lang.Object

software.amazon.awssdk.services.opensearch.model.CognitoOptions

All Implemented Interfaces:

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

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

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CognitoOptions.Builder

Method Summary

Modifier and Type	Method	Description
static CognitoOptions.Builder	builder()
Boolean	enabled()	Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityPoolId()	The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
String	roleArn()	The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CognitoOptions.Builder>	serializableBuilderClass()
CognitoOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

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

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

Returns:

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

userPoolId

public final String userPoolId()

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Returns:

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

identityPoolId

public final String identityPoolId()

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Returns:

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

roleArn

public final String roleArn()

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

Returns:

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

toBuilder

public CognitoOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>

builder

public static CognitoOptions.Builder builder()

serializableBuilderClass

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