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(value="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 and Description
static interface	CognitoOptions.Builder

Method Summary

Modifier and Type	Method and Description
static CognitoOptions.Builder	builder()
Boolean	enabled() Specifies the option to enable Cognito for Kibana authentication.
boolean	equals(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.
List<SdkField<?>>	sdkFields()
static Class<? extends CognitoOptions.Builder>	serializableBuilderClass()
CognitoOptions.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId() Specifies the Cognito user pool ID for Kibana authentication.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public Boolean enabled()

Specifies the option to enable Cognito for Kibana authentication.

Returns:

Specifies the option to enable Cognito for Kibana authentication.

userPoolId

public String userPoolId()

Specifies the Cognito user pool ID for Kibana authentication.

Returns:

Specifies the Cognito user pool ID for Kibana authentication.

identityPoolId

public String identityPoolId()

Specifies the Cognito identity pool ID for Kibana authentication.

Returns:

Specifies the Cognito identity pool ID for Kibana authentication.

roleArn

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CognitoOptions.Builder,CognitoOptions>

Returns:

a builder for type T

builder

public static CognitoOptions.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.