Package software.amazon.awssdk.services.elasticsearch.model

Class CognitoOptions

java.lang.Object

software.amazon.awssdk.services.elasticsearch.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>

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

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()	Specifies the option to enable Cognito for Kibana authentication.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityPoolId()	Specifies the Cognito identity pool ID for Kibana authentication.
String	roleArn()	Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
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()	Specifies the Cognito user pool ID for Kibana 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()

Specifies the option to enable Cognito for Kibana authentication.

Returns:

Specifies the option to enable Cognito for Kibana authentication.

userPoolId

public final String userPoolId()

Specifies the Cognito user pool ID for Kibana authentication.

Returns:

Specifies the Cognito user pool ID for Kibana authentication.

identityPoolId

public final String identityPoolId()

Specifies the Cognito identity pool ID for Kibana authentication.

Returns:

Specifies the Cognito identity pool ID for Kibana authentication.

roleArn

public final String roleArn()

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Returns:

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

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