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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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].

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1336

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

#identity_pool_id ⇒ String

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

Returns:

  • (String) 


1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1336

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

#role_arn ⇒ String

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

Returns:

  • (String) 


1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1336

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

#user_pool_id ⇒ String

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

Returns:

  • (String) 


1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 1336

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