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

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

Overview

Note:

When making an API call, you may pass CognitoOptions data as a hash:

{
  enabled: false,
  user_pool_id: "UserPoolId",
  identity_pool_id: "IdentityPoolId",
  role_arn: "RoleArn",
}

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

The option to enable Cognito for OpenSearch Dashboards authentication.

Returns:

  • (Boolean)


854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 854

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

#identity_pool_idString

The Cognito identity pool ID for OpenSearch Dashboards authentication.

Returns:

  • (String)


854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 854

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

#role_arnString

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

Returns:

  • (String)


854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 854

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

#user_pool_idString

The Cognito user pool ID for OpenSearch Dashboards authentication.

Returns:

  • (String)


854
855
856
857
858
859
860
861
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 854

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