AWS CDK Reference

Appearance

v2.273.0

CognitoOptions Struct ​

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

Source
aws-opensearchservice/lib/domain.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

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

Properties ​

identityPoolIdstringidentity_pool_idstridentityPoolIdStringIdentityPoolIdstringIdentityPoolId*stringrequired#
The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.
roleIRoleRefroleIRoleRefroleIRoleRefRoleIRoleRefRoleIRoleRefrequired#
A role that allows Amazon OpenSearch Service to configure your user pool and identity pool.

It must have the AmazonESCognitoAccess policy attached to it.

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