aws-cdk-lib.aws_opensearchservice.CfnDomain.CognitoOptionsProperty

interface CognitoOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CfnDomain.CognitoOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_CognitoOptionsProperty
Javasoftware.amazon.awscdk.services.opensearchservice.CfnDomain.CognitoOptionsProperty
Pythonaws_cdk.aws_opensearchservice.CfnDomain.CognitoOptionsProperty
TypeScript aws-cdk-lib » 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 { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const cognitoOptionsProperty: opensearchservice.CfnDomain.CognitoOptionsProperty = {
  enabled: false,
  identityPoolId: 'identityPoolId',
  roleArn: 'roleArn',
  userPoolId: 'userPoolId',
};

Properties

NameTypeDescription
enabled?boolean | IResolvableWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
identityPoolId?stringThe Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
roleArn?stringThe AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
userPoolId?stringThe 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.