interface CognitoOptionsProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.OpenSearchService.CfnDomain.CognitoOptionsProperty |
Java | software.amazon.awscdk.services.opensearchservice.CfnDomain.CognitoOptionsProperty |
Python | aws_cdk.aws_opensearchservice.CfnDomain.CognitoOptionsProperty |
TypeScript | @aws-cdk/aws-opensearchservice » CfnDomain » CognitoOptionsProperty |
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as opensearchservice from '@aws-cdk/aws-opensearchservice';
const cognitoOptionsProperty: opensearchservice.CfnDomain.CognitoOptionsProperty = {
enabled: false,
identityPoolId: 'identityPoolId',
roleArn: 'roleArn',
userPoolId: 'userPoolId',
};
Properties
Name | Type | Description |
---|---|---|
enabled? | boolean | IResolvable | Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. |
identity | string | The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. |
role | string | The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. |
user | string | The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. |
enabled?
Type:
boolean |
IResolvable
(optional)
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
See Amazon Cognito authentication for OpenSearch Dashboards .
identityPoolId?
Type:
string
(optional)
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
Required if you enabled Cognito Authentication for OpenSearch Dashboards.
roleArn?
Type:
string
(optional)
The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
Required if you enabled Cognito Authentication for OpenSearch Dashboards.
userPoolId?
Type:
string
(optional)
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
Required if you enabled Cognito Authentication for OpenSearch Dashboards.