Class: AWSCDK::OpenSearchService::CfnDomain::CognitoOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::OpenSearchService::CfnDomain::CognitoOptionsProperty

Defined in:

open_search_service/cfn_domain.rb

Overview

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

See Also:

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

Instance Attribute Summary

• #enabled ⇒ Boolean, ... readonly

  Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

• #identity_pool_id ⇒ String^? readonly

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

• #role_arn ⇒ String^? readonly

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

• #user_pool_id ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(enabled: nil, identity_pool_id: nil, role_arn: nil, user_pool_id: nil) ⇒ CognitoOptionsProperty constructor

  A new instance of CognitoOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(enabled: nil, identity_pool_id: nil, role_arn: nil, user_pool_id: nil) ⇒ CognitoOptionsProperty

Returns a new instance of CognitoOptionsProperty.

Parameters:

• enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

• identity_pool_id (String, nil) (defaults to: nil) —

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

• role_arn (String, nil) (defaults to: nil) —

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

• user_pool_id (String, nil) (defaults to: nil) —

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

# File 'open_search_service/cfn_domain.rb', line 1326

def initialize(enabled: nil, identity_pool_id: nil, role_arn: nil, user_pool_id: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @identity_pool_id = identity_pool_id
  Jsii::Type.check_type(@identity_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolId") unless @identity_pool_id.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId") unless @user_pool_id.nil?
end

Instance Attribute Details

#enabled ⇒ Boolean, ... (readonly)

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

See Amazon Cognito authentication for OpenSearch Dashboards .

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

# File 'open_search_service/cfn_domain.rb', line 1343

def enabled
  @enabled
end

#identity_pool_id ⇒ String^? (readonly)

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:

• (String, nil)

See Also:

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

# File 'open_search_service/cfn_domain.rb', line 1350

def identity_pool_id
  @identity_pool_id
end

#role_arn ⇒ String^? (readonly)

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:

• (String, nil)

See Also:

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

# File 'open_search_service/cfn_domain.rb', line 1357

def role_arn
  @role_arn
end

#user_pool_id ⇒ String^? (readonly)

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:

• (String, nil)

See Also:

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

# File 'open_search_service/cfn_domain.rb', line 1364

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 1366

def self.jsii_properties
  {
    :enabled => "enabled",
    :identity_pool_id => "identityPoolId",
    :role_arn => "roleArn",
    :user_pool_id => "userPoolId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 1375

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "identityPoolId" => @identity_pool_id,
    "roleArn" => @role_arn,
    "userPoolId" => @user_pool_id,
  })
  result.compact
end