software.amazon.awscdk.services.opensearchservice

Interface CognitoOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CognitoOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:53.806Z")
 @Stability(value=Experimental)
public interface CognitoOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Example:

 Domain.Builder.create(this, "Domain")
         .cognitoDashboardsAuth(CognitoOptions.builder()
                 .identityPoolId("test-identity-pool-id")
                 .userPoolId("test-user-pool-id")
                 .role(role)
                 .build())
         .version(openSearchVersion)
         .build();
 

See Also:

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CognitoOptions.Builder A builder for CognitoOptions
static class	CognitoOptions.Jsii$Proxy An implementation for CognitoOptions

Method Summary

Modifier and Type	Method and Description
static CognitoOptions.Builder	builder()
String	getIdentityPoolId() (experimental) The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.
IRole	getRole() (experimental) A role that allows Amazon OpenSearch Service to configure your user pool and identity pool.
String	getUserPoolId() (experimental) The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentityPoolId

@Stability(value=Experimental)
 @NotNull
String getIdentityPoolId()

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

getRole

@Stability(value=Experimental)
 @NotNull
IRole getRole()

(experimental) A role that allows Amazon OpenSearch Service to configure your user pool and identity pool.

It must have the AmazonESCognitoAccess policy attached to it.

See Also:

https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html#cognito-auth-prereq

getUserPoolId

@Stability(value=Experimental)
 @NotNull
String getUserPoolId()

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

builder

@Stability(value=Experimental)
static CognitoOptions.Builder builder()

Returns:

a CognitoOptions.Builder of CognitoOptions