Interface CognitoOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CognitoOptions.Builder,CognitoOptions>, SdkBuilder<CognitoOptions.Builder,CognitoOptions>, SdkPojo

Enclosing class:

CognitoOptions

@Mutable
@NotThreadSafe
public static interface CognitoOptions.Builder
extends SdkPojo, CopyableBuilder<CognitoOptions.Builder,CognitoOptions>

Method Summary

Modifier and Type	Method	Description
CognitoOptions.Builder	enabled(Boolean enabled)	Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
CognitoOptions.Builder	identityPoolId(String identityPoolId)	The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
CognitoOptions.Builder	roleArn(String roleArn)	The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
CognitoOptions.Builder	userPoolId(String userPoolId)	The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

enabled

CognitoOptions.Builder enabled(Boolean enabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolId

CognitoOptions.Builder userPoolId(String userPoolId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

identityPoolId

CognitoOptions.Builder identityPoolId(String identityPoolId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

CognitoOptions.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.