Package software.amazon.awscdk.services.elasticsearch

Interface CognitoOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CognitoOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.471Z")
@Stability(Deprecated)
@Deprecated
public interface CognitoOptions
extends software.amazon.jsii.JsiiSerializable

Deprecated.

use opensearchservice module instead

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

Example:

 Domain.Builder.create(this, "Domain")
         .cognitoKibanaAuth(CognitoOptions.builder()
                 .identityPoolId("test-identity-pool-id")
                 .userPoolId("test-user-pool-id")
                 .role(role)
                 .build())
         .version(elasticsearchVersion)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CognitoOptions.Builder	Deprecated.
static final class	CognitoOptions.Jsii$Proxy	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CognitoOptions.Builder	builder()	Deprecated.
String	getIdentityPoolId()	Deprecated. use opensearchservice module instead
IRole	getRole()	Deprecated. use opensearchservice module instead
String	getUserPoolId()	Deprecated. use opensearchservice module instead

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityPoolId

@Stability(Deprecated)
@Deprecated
@NotNull
String getIdentityPoolId()

Deprecated.

use opensearchservice module instead

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

getRole

@Stability(Deprecated)
@Deprecated
@NotNull
IRole getRole()

Deprecated.

use opensearchservice module instead

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

It must have the AmazonESCognitoAccess policy attached to it.

See Also:

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

getUserPoolId

@Stability(Deprecated)
@Deprecated
@NotNull
String getUserPoolId()

Deprecated.

use opensearchservice module instead

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

builder

@Stability(Deprecated)
@Deprecated
static CognitoOptions.Builder builder()

Deprecated.

Returns:

a CognitoOptions.Builder of CognitoOptions