Package software.amazon.awscdk.services.elasticsearch

Interface CfnDomain.CognitoOptionsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomain.CognitoOptionsProperty.Jsii$Proxy
Enclosing class:
CfnDomain
@Stability(Stable) public static interface CfnDomain.CognitoOptionsProperty extends software.amazon.jsii.JsiiSerializable
Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 New resource types in the Amazon OpenSearch Service Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticsearch.*;
 CognitoOptionsProperty cognitoOptionsProperty = CognitoOptionsProperty.builder()
         .enabled(false)
         .identityPoolId("identityPoolId")
         .roleArn("roleArn")
         .userPoolId("userPoolId")
         .build();

  • Method Details

    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      See Amazon Cognito authentication for OpenSearch Dashboards .

    • getIdentityPoolId

      @Stability(Stable) @Nullable default String getIdentityPoolId()
      The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      Required if you enable Cognito authentication.

    • getRoleArn

      @Stability(Stable) @Nullable default String getRoleArn()
      The AmazonESCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

      Required if you enable Cognito authentication.

    • getUserPoolId

      @Stability(Stable) @Nullable default String getUserPoolId()
      The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      Required if you enable Cognito authentication.

    • builder

      @Stability(Stable) static CfnDomain.CognitoOptionsProperty.Builder builder()
      Returns:
      a CfnDomain.CognitoOptionsProperty.Builder of CfnDomain.CognitoOptionsProperty