Class CognitoOptions
(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.AWS.Elasticsearch.dll
Syntax (csharp)
public class CognitoOptions : Object, ICognitoOptions
Syntax (vb)
Public Class CognitoOptions
Inherits Object
Implements ICognitoOptions
Remarks
Stability: Deprecated
See: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html
ExampleMetadata: fixture=migrate-opensearch infused
Examples
new Domain(this, "Domain", new DomainProps {
CognitoKibanaAuth = new CognitoOptions {
IdentityPoolId = "test-identity-pool-id",
UserPoolId = "test-user-pool-id",
Role = role
},
Version = elasticsearchVersion
});
Synopsis
Constructors
CognitoOptions() |
Properties
IdentityPoolId | (deprecated) The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication. |
Role | (deprecated) A role that allows Amazon ES to configure your user pool and identity pool. |
UserPoolId | (deprecated) The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication. |
Constructors
CognitoOptions()
public CognitoOptions()
Properties
IdentityPoolId
(deprecated) The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.
public string IdentityPoolId { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
Role
(deprecated) A role that allows Amazon ES 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.
Stability: Deprecated
UserPoolId
(deprecated) The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.
public string UserPoolId { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated