Skip to content

CognitoOptions

Used by
Source code in docs_src/capo_opensearch/types/cognito_options.py 
14
15
16
17
18
19
20
21
22
23
24
class CognitoOptions(TypedDict, closed=True):
    enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</p>"""
    user_pool_id: NotRequired["capo_opensearch.types.user_pool_id.UserPoolId"]
    """<p>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>"""
    identity_pool_id: NotRequired[
        "capo_opensearch.types.identity_pool_id.IdentityPoolId"
    ]
    """<p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>"""
    role_arn: NotRequired["capo_opensearch.types.role_arn.RoleArn"]
    """<p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch Service to configure your user pool and identity pool.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

identity_pool_id instance-attribute 

identity_pool_id: NotRequired[IdentityPoolId]

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

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

user_pool_id instance-attribute 

user_pool_id: NotRequired[UserPoolId]

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