aws-cdk-lib.aws_elasticsearch.CfnDomain.CognitoOptionsProperty

interface CognitoOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.Elasticsearch.CfnDomain.CognitoOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#CfnDomain_CognitoOptionsProperty
Javasoftware.amazon.awscdk.services.elasticsearch.CfnDomain.CognitoOptionsProperty
Pythonaws_cdk.aws_elasticsearch.CfnDomain.CognitoOptionsProperty
TypeScript aws-cdk-lib » aws_elasticsearch » CfnDomain » CognitoOptionsProperty

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticsearch as elasticsearch } from 'aws-cdk-lib';
const cognitoOptionsProperty: elasticsearch.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 AmazonESCognitoAccess 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 enable Cognito authentication.


roleArn?

Type: string (optional)

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

Required if you enable Cognito authentication.


userPoolId?

Type: string (optional)

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

Required if you enable Cognito authentication.