Package software.amazon.awscdk.cfnpropertymixins.services.opensearchservice

Interface CfnDomainPropsMixin.CognitoOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainPropsMixin.CognitoOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomainPropsMixin

@Stability(Stable)
public static interface CfnDomainPropsMixin.CognitoOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Example:

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainPropsMixin.CognitoOptionsProperty.Builder	A builder for CfnDomainPropsMixin.CognitoOptionsProperty
static final class	CfnDomainPropsMixin.CognitoOptionsProperty.Jsii$Proxy	An implementation for CfnDomainPropsMixin.CognitoOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomainPropsMixin.CognitoOptionsProperty.Builder	builder()
default Object	getEnabled()	Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
default Object	getIdentityPoolId()	The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
default Object	getRoleArn()	The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
default Object	getUserPoolId()	The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-enabled

getIdentityPoolId

@Stability(Stable)
@Nullable
default Object getIdentityPoolId()

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

Returns union: either String or IIdentityPoolRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-identitypoolid

getRoleArn

@Stability(Stable)
@Nullable
default Object getRoleArn()

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-rolearn

getUserPoolId

@Stability(Stable)
@Nullable
default Object getUserPoolId()

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

Required if you enabled Cognito Authentication for OpenSearch Dashboards.

Returns union: either String or IUserPoolRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-cognitooptions.html#cfn-opensearchservice-domain-cognitooptions-userpoolid

builder

@Stability(Stable)
static CfnDomainPropsMixin.CognitoOptionsProperty.Builder builder()

Returns:

a CfnDomainPropsMixin.CognitoOptionsProperty.Builder of CfnDomainPropsMixin.CognitoOptionsProperty