Interface ICognitoOptions

(deprecated) Configures Amazon ES to use Amazon Cognito authentication for Kibana.

Namespace: Amazon.CDK.AWS.Elasticsearch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

[Obsolete("use opensearchservice module instead")]
public interface ICognitoOptions

Syntax (vb)

<Obsolete("use opensearchservice module instead")>
Public Interface 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

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.

Properties

IdentityPoolId

(deprecated) The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.

[Obsolete("use opensearchservice module instead")]
string IdentityPoolId { get; }

Property Value

string

Remarks

Stability: Deprecated

Role

(deprecated) A role that allows Amazon ES to configure your user pool and identity pool.

[Obsolete("use opensearchservice module instead")]
IRole Role { get; }

Property Value

IRole

Remarks

It must have the AmazonESCognitoAccess policy attached to it.

Stability: Deprecated

See: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html#es-cognito-auth-prereq

UserPoolId

(deprecated) The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.

[Obsolete("use opensearchservice module instead")]
string UserPoolId { get; }

Property Value

string

Remarks

Stability: Deprecated