Class CognitoOptions
Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CognitoOptions : Object, ICognitoOptions
Syntax (vb)
Public Class CognitoOptions
Inherits Object
Implements ICognitoOptions
Remarks
See: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
ExampleMetadata: fixture=migrate-opensearch infused
Examples
new Domain(this, "Domain", new DomainProps {
CognitoDashboardsAuth = new CognitoOptions {
IdentityPoolId = "test-identity-pool-id",
UserPoolId = "test-user-pool-id",
Role = role
},
Version = openSearchVersion
});
Synopsis
Constructors
CognitoOptions() |
Properties
IdentityPoolId | The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication. |
Role | A role that allows Amazon OpenSearch Service to configure your user pool and identity pool. |
UserPoolId | The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication. |
Constructors
CognitoOptions()
public CognitoOptions()
Properties
IdentityPoolId
The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.
public string IdentityPoolId { get; set; }
Property Value
System.String
Role
A role that allows Amazon OpenSearch Service to configure your user pool and identity pool.
public IRole Role { get; set; }
Property Value
Remarks
It must have the AmazonESCognitoAccess
policy attached to it.
UserPoolId
The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication.
public string UserPoolId { get; set; }
Property Value
System.String