Class: Aws::ElasticsearchService::Types::CognitoOptions

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-elasticsearchservice/types.rb

Overview

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see [Amazon Cognito Authentication for Kibana].

[1]: docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

Specifies the option to enable Cognito for Kibana authentication.

Returns:

  • (Boolean) 


796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 796

class CognitoOptions < Struct.new(
  :enabled,
  :user_pool_id,
  :identity_pool_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_id ⇒ String

Specifies the Cognito identity pool ID for Kibana authentication.

Returns:

  • (String) 


796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 796

class CognitoOptions < Struct.new(
  :enabled,
  :user_pool_id,
  :identity_pool_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

Returns:

  • (String) 


796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 796

class CognitoOptions < Struct.new(
  :enabled,
  :user_pool_id,
  :identity_pool_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

Specifies the Cognito user pool ID for Kibana authentication.

Returns:

  • (String) 


796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-elasticsearchservice/types.rb', line 796

class CognitoOptions < Struct.new(
  :enabled,
  :user_pool_id,
  :identity_pool_id,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end