interface CognitoOptions

Language	Type name
.NET	Amazon.CDK.AWS.OpenSearchService.CognitoOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CognitoOptions
Java	software.amazon.awscdk.services.opensearchservice.CognitoOptions
Python	aws_cdk.aws_opensearchservice.CognitoOptions
TypeScript (source)	aws-cdk-lib » aws_opensearchservice » CognitoOptions

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

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

Example

new opensearch.Domain(this, 'Domain', {
  cognitoDashboardsAuth: {
    identityPoolId: 'test-identity-pool-id',
    userPoolId: 'test-user-pool-id',
    role: role,
  },
  version: openSearchVersion,
});

Properties

Name	Type	Description
identityPoolId	string	The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.
role	IRole	A role that allows Amazon OpenSearch Service to configure your user pool and identity pool.
userPoolId	string	The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.

---

identityPoolId

Type: string

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

---

role

Type: IRole

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

---

userPoolId

Type: string

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