interface CognitoOptions ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Elasticsearch.CognitoOptions
Java	software.amazon.awscdk.services.elasticsearch.CognitoOptions
Python	aws_cdk.aws_elasticsearch.CognitoOptions
TypeScript (source)	@aws-cdk/aws-elasticsearch » CognitoOptions

⚠️ Deprecated: use opensearchservice module instead

Configures Amazon ES to use Amazon Cognito authentication for Kibana.

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

Example

new es.Domain(this, 'Domain', {
  cognitoKibanaAuth: {
    identityPoolId: 'test-identity-pool-id',
    userPoolId: 'test-user-pool-id',
    role: role,
  },
  version: elasticsearchVersion,
});

Properties

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

---

identityPoolId⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string

The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.

---

role⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: IRole

A role that allows Amazon ES to configure your user pool and identity pool.

It must have the AmazonESCognitoAccess policy attached to it.

See also: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html#es-cognito-auth-prereq

---

userPoolId⚠️

⚠️ Deprecated: use opensearchservice module instead

Type: string

The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.