software.amazon.awscdk.services.opensearchservice

Class CognitoOptions.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CognitoOptions.Builder

Enclosing interface:

CognitoOptions

public static final class CognitoOptions.Builder
extends java.lang.Object

A builder for CognitoOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CognitoOptions	build() Builds the configured instance.
CognitoOptions.Builder	identityPoolId(java.lang.String identityPoolId) Sets the value of CognitoOptions.getIdentityPoolId()
CognitoOptions.Builder	role(IRole role) Sets the value of CognitoOptions.getRole()
CognitoOptions.Builder	userPoolId(java.lang.String userPoolId) Sets the value of CognitoOptions.getUserPoolId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

identityPoolId

public CognitoOptions.Builder identityPoolId(java.lang.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

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

public CognitoOptions.Builder userPoolId(java.lang.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

public CognitoOptions build()

Builds the configured instance.

Returns:

a new instance of CognitoOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided