Class CfnDomain.CognitoOptionsProperty
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.AWS.Elasticsearch.dll
Syntax (csharp)
public class CognitoOptionsProperty : Object, CfnDomain.ICognitoOptionsProperty
Syntax (vb)
Public Class CognitoOptionsProperty
Inherits Object
Implements CfnDomain.ICognitoOptionsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Elasticsearch;
var cognitoOptionsProperty = new CognitoOptionsProperty {
Enabled = false,
IdentityPoolId = "identityPoolId",
RoleArn = "roleArn",
UserPoolId = "userPoolId"
};
Synopsis
Constructors
CognitoOptionsProperty() |
Properties
Enabled | Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. |
IdentityPoolId | The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. |
RoleArn | The |
UserPoolId | The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. |
Constructors
CognitoOptionsProperty()
public CognitoOptionsProperty()
Properties
Enabled
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
IdentityPoolId
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
public string IdentityPoolId { get; set; }
Property Value
System.String
Remarks
Required if you enable Cognito authentication.
RoleArn
The AmazonESCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Required if you enable Cognito authentication.
UserPoolId
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
public string UserPoolId { get; set; }
Property Value
System.String
Remarks
Required if you enable Cognito authentication.