AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CognitoOptions as input to an Aws::Client method, you can use a vanilla Hash:

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

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies the option to enable Cognito for Kibana authentication.

Returns:

  • (Boolean)

    Specifies the option to enable Cognito for Kibana authentication.

#identity_pool_idString

Specifies the Cognito identity pool ID for Kibana authentication.

Returns:

  • (String)

    Specifies the Cognito identity pool ID for Kibana authentication.

#role_arnString

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

Returns:

  • (String)

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

#user_pool_idString

Specifies the Cognito user pool ID for Kibana authentication.

Returns:

  • (String)

    Specifies the Cognito user pool ID for Kibana authentication.