Package software.amazon.awscdk.services.opensearchservice

Class CognitoOptions.Builder

java.lang.Object
software.amazon.awscdk.services.opensearchservice.CognitoOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CognitoOptions>
Enclosing interface:
CognitoOptions
@Stability(Stable) public static final class CognitoOptions.Builder extends Object implements software.amazon.jsii.Builder<CognitoOptions>
A builder for CognitoOptions

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • identityPoolId

      @Stability(Stable) public CognitoOptions.Builder identityPoolId(String identityPoolId)
      Sets the value of CognitoOptions.getIdentityPoolId()
      Parameters:
      identityPoolId - The Amazon Cognito identity pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public CognitoOptions.Builder role(IRole role)
      Sets the value of CognitoOptions.getRole()
      Parameters:
      role - A role that allows Amazon OpenSearch Service to configure your user pool and identity pool. This parameter is required. It must have the AmazonESCognitoAccess policy attached to it.
      Returns:
      this

    • userPoolId

      @Stability(Stable) public CognitoOptions.Builder userPoolId(String userPoolId)
      Sets the value of CognitoOptions.getUserPoolId()
      Parameters:
      userPoolId - The Amazon Cognito user pool ID that you want Amazon OpenSearch Service to use for OpenSearch Dashboards authentication. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CognitoOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CognitoOptions>
      Returns:
      a new instance of CognitoOptions
      Throws:
      NullPointerException - if any required attribute was not provided