software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.CognitoOptionsProperty

All Known Implementing Classes:

CfnDomain.CognitoOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

public static interface CfnDomain.CognitoOptionsProperty

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 CognitoOptionsProperty cognitoOptionsProperty = CognitoOptionsProperty.builder()
         .enabled(false)
         .identityPoolId("identityPoolId")
         .roleArn("roleArn")
         .userPoolId("userPoolId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomain.CognitoOptionsProperty.Builder	builder()
default java.lang.Object	getEnabled() Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
default java.lang.String	getIdentityPoolId() The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
default java.lang.String	getRoleArn() The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool.
default java.lang.String	getUserPoolId() The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Method Detail

getEnabled

default java.lang.Object getEnabled()

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

See Amazon Cognito authentication for OpenSearch Dashboards .

getIdentityPoolId

default java.lang.String getIdentityPoolId()

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

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

getRoleArn

default java.lang.String getRoleArn()

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

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

getUserPoolId

default java.lang.String getUserPoolId()

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

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

builder

static CfnDomain.CognitoOptionsProperty.Builder builder()

Returns:

a CfnDomain.CognitoOptionsProperty.Builder of CfnDomain.CognitoOptionsProperty