/AWS1/CL_OSRCOGNITOOPTIONS¶
Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_enabled TYPE /AWS1/OSRBOOLEAN /AWS1/OSRBOOLEAN¶
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
iv_userpoolid TYPE /AWS1/OSRUSERPOOLID /AWS1/OSRUSERPOOLID¶
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
iv_identitypoolid TYPE /AWS1/OSRIDENTITYPOOLID /AWS1/OSRIDENTITYPOOLID¶
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
iv_rolearn TYPE /AWS1/OSRROLEARN /AWS1/OSRROLEARN¶
The
AmazonOpenSearchServiceCognitoAccessrole that allows OpenSearch Service to configure your user pool and identity pool.
Queryable Attributes¶
Enabled¶
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED, with configurable default |
ASK_ENABLED() |
Getter for ENABLED w/ exceptions if field has no value |
HAS_ENABLED() |
Determine if ENABLED has a value |
UserPoolId¶
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERPOOLID() |
Getter for USERPOOLID, with configurable default |
ASK_USERPOOLID() |
Getter for USERPOOLID w/ exceptions if field has no value |
HAS_USERPOOLID() |
Determine if USERPOOLID has a value |
IdentityPoolId¶
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTITYPOOLID() |
Getter for IDENTITYPOOLID, with configurable default |
ASK_IDENTITYPOOLID() |
Getter for IDENTITYPOOLID w/ exceptions if field has no valu |
HAS_IDENTITYPOOLID() |
Determine if IDENTITYPOOLID has a value |
RoleArn¶
The
AmazonOpenSearchServiceCognitoAccessrole that allows OpenSearch Service to configure your user pool and identity pool.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |