Class: AWSCDK::Elasticsearch::CognitoOptions Deprecated

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elasticsearch/cognito_options.rb

Overview

Deprecated.

use opensearchservice module instead

Configures Amazon ES to use Amazon Cognito authentication for Kibana.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity_pool_id:, role:, user_pool_id:) ⇒ CognitoOptions

Returns a new instance of CognitoOptions.

Parameters:

  • identity_pool_id (String) —

    The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.

  • role (AWSCDK::IAM::IRole) —

    A role that allows Amazon ES to configure your user pool and identity pool.

  • user_pool_id (String) —

    The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.



13
14
15
16
17
18
19
20
 
# File 'elasticsearch/cognito_options.rb', line 13

def initialize(identity_pool_id:, role:, user_pool_id:)
  @identity_pool_id = identity_pool_id
  Jsii::Type.check_type(@identity_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolId")
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
end

Instance Attribute Details

#identity_pool_id ⇒ String (readonly)

Deprecated.

use opensearchservice module instead

The Amazon Cognito identity pool ID that you want Amazon ES to use for Kibana authentication.

Returns:

  • (String) 


26
27
28
 
# File 'elasticsearch/cognito_options.rb', line 26

def identity_pool_id
  @identity_pool_id
end

#role ⇒ AWSCDK::IAM::IRole (readonly)

Deprecated.

use opensearchservice module instead

A role that allows Amazon ES to configure your user pool and identity pool.

It must have the AmazonESCognitoAccess policy attached to it.

Returns:

See Also:



34
35
36
 
# File 'elasticsearch/cognito_options.rb', line 34

def role
  @role
end

#user_pool_id ⇒ String (readonly)

Deprecated.

use opensearchservice module instead

The Amazon Cognito user pool ID that you want Amazon ES to use for Kibana authentication.

Returns:

  • (String) 


39
40
41
 
# File 'elasticsearch/cognito_options.rb', line 39

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'elasticsearch/cognito_options.rb', line 41

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

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'elasticsearch/cognito_options.rb', line 49

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