Class CfnDomain.CognitoOptionsProperty

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

Inheritance

object

CfnDomain.CognitoOptionsProperty

Implements

CfnDomain.ICognitoOptionsProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomain.CognitoOptionsProperty : CfnDomain.ICognitoOptionsProperty

Syntax (vb)

Public Class CfnDomain.CognitoOptionsProperty Implements CfnDomain.ICognitoOptionsProperty

Remarks

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> 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 <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html

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()

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

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 AmazonESCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
UserPoolId	The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Constructors

CognitoOptionsProperty()

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

public CognitoOptionsProperty()

Remarks

The <code>AWS::Elasticsearch::Domain</code> resource is being replaced by the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html">AWS::OpenSearchService::Domain</a> 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 <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource">New resource types</a> in the <em>Amazon OpenSearch Service Developer Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html

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"
             };

Properties

Enabled

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

public object? Enabled { get; set; }

Property Value

object

Remarks

See Amazon Cognito authentication for OpenSearch Dashboards .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-enabled

Type union: either bool or IResolvable

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

string

Remarks

Required if you enable Cognito authentication.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-identitypoolid

RoleArn

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

public string? RoleArn { get; set; }

Property Value

string

Remarks

Required if you enable Cognito authentication.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-rolearn

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

string

Remarks

Required if you enable Cognito authentication.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-cognitooptions.html#cfn-elasticsearch-domain-cognitooptions-userpoolid

Implements

CfnDomain.ICognitoOptionsProperty