Class: Aws::OpenSearchService::Types::CognitoOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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

Returns:

  • (Boolean)


897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 897

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

#identity_pool_idString

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

Returns:

  • (String)


897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 897

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

#role_arnString

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

Returns:

  • (String)


897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 897

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

#user_pool_idString

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

Returns:

  • (String)


897
898
899
900
901
902
903
904
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 897

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