Interface CognitoOptions.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<CognitoOptions.Builder,
,CognitoOptions> SdkBuilder<CognitoOptions.Builder,
,CognitoOptions> SdkPojo
- Enclosing class:
CognitoOptions
public static interface CognitoOptions.Builder
extends SdkPojo, CopyableBuilder<CognitoOptions.Builder,CognitoOptions>
-
Method Summary
Modifier and TypeMethodDescriptionWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.identityPoolId
(String identityPoolId) The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.TheAmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.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, sdkFields
-
Method Details
-
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
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
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
The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.- Parameters:
roleArn
- TheAmazonOpenSearchServiceCognitoAccess
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.
-