AWS::Elasticsearch::Domain CognitoOptions - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Elasticsearch::Domain CognitoOptions

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

Important

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Enabled" : Boolean,
  "IdentityPoolId" : String,
  "RoleArn" : String,
  "UserPoolId" : String
}

YAML

  Enabled: Boolean
  IdentityPoolId: String
  RoleArn: String
  UserPoolId: String

Properties

Enabled

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See Amazon Cognito authentication for OpenSearch Dashboards.

Required: No

Type: Boolean

Update requires: No interruption

IdentityPoolId

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. Required if you enable Cognito authentication.

Required: Conditional

Type: String

Update requires: No interruption

RoleArn

The AmazonESCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. Required if you enable Cognito authentication.

Required: Conditional

Type: String

Update requires: No interruption

UserPoolId

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

Required: Conditional

Type: String

Update requires: No interruption