Skip to content

CognitoOptions

Used by
Source code in docs_src/capo_elasticsearch_service/types/cognito_options.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class CognitoOptions(TypedDict, closed=True):
    enabled: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>Specifies the option to enable Cognito for Kibana authentication.</p>"""
    user_pool_id: NotRequired[
        "capo_elasticsearch_service.types.user_pool_id.UserPoolId"
    ]
    """<p>Specifies the Cognito user pool ID for Kibana authentication.</p>"""
    identity_pool_id: NotRequired[
        "capo_elasticsearch_service.types.identity_pool_id.IdentityPoolId"
    ]
    """<p>Specifies the Cognito identity pool ID for Kibana authentication.</p>"""
    role_arn: NotRequired["capo_elasticsearch_service.types.role_arn.RoleArn"]
    """<p>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</p>"""

enabled instance-attribute 

enabled: NotRequired[Boolean]

Specifies the option to enable Cognito for Kibana authentication.

identity_pool_id instance-attribute 

identity_pool_id: NotRequired[IdentityPoolId]

Specifies the Cognito identity pool ID for Kibana authentication.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

user_pool_id instance-attribute 

user_pool_id: NotRequired[UserPoolId]

Specifies the Cognito user pool ID for Kibana authentication.