CognitoOptions¶

class aws_cdk.aws_opensearchservice.CognitoOptions(*, identity_pool_id, role, user_pool_id)¶

Bases: object

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

Parameters

identity_pool_id (str) – 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. It must have the AmazonESCognitoAccess policy attached to it.
user_pool_id (str) – The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.

See

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

ExampleMetadata

fixture=migrate-opensearch infused

Example:

opensearch.Domain(self, "Domain",
    cognito_dashboards_auth=opensearch.CognitoOptions(
        identity_pool_id="test-identity-pool-id",
        user_pool_id="test-user-pool-id",
        role=role
    ),
    version=open_search_version
)

Attributes

identity_pool_id¶

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

Return type: str

role¶

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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html#cognito-auth-prereq
Return type: IRole

user_pool_id¶

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

Return type: str