CognitoOptions

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

AnalyticsElasticsearchSearch

Properties

Name Type Description
Enabled object
UserPoolId object
IdentityPoolId object
RoleArn object
View JSON Schema on GitHub

JSON Schema

openapi-cognito-options-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-cognito-options-schema.json",
  "title": "CognitoOptions",
  "description": "Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.",
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Specifies the option to enable Cognito for Kibana authentication."
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolId"
        },
        {
          "description": "Specifies the Cognito user pool ID for Kibana authentication."
        }
      ]
    },
    "IdentityPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolId"
        },
        {
          "description": "Specifies the Cognito identity pool ID for Kibana authentication."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleArn"
        },
        {
          "description": "Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources."
        }
      ]
    }
  }
}