CognitoOptions

class aws_cdk.aws_elasticsearch.CognitoOptions(*, identity_pool_id, role, user_pool_id)

Bases: object

(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.

Parameters
  • identity_pool_id (str) – (deprecated) The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.

  • role (IRole) – (deprecated) A role that allows Amazon ES to configure your user pool and identity pool. It must have the AmazonESCognitoAccess policy attached to it.

  • user_pool_id (str) – (deprecated) The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.

Deprecated

use opensearchservice module instead

See

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

Stability

deprecated

ExampleMetadata

fixture=migrate-opensearch infused

Example:

es.Domain(self, "Domain",
    cognito_kibana_auth=es.CognitoOptions(
        identity_pool_id="test-identity-pool-id",
        user_pool_id="test-user-pool-id",
        role=role
    ),
    version=elasticsearch_version
)

Attributes

identity_pool_id

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

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

str

role

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

It must have the AmazonESCognitoAccess policy attached to it.

Deprecated

use opensearchservice module instead

See

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

Stability

deprecated

Return type

IRole

user_pool_id

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

Deprecated

use opensearchservice module instead

Stability

deprecated

Return type

str