Amazon OpenSearch Service API · JSON Structure

Openapi Cognito Options Structure

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

Type: object Properties: 4
AnalyticsElasticsearchSearch

CognitoOptions is a JSON Structure definition published by Amazon OpenSearch Service API, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Enabled UserPoolId IdentityPoolId RoleArn

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-cognito-options-structure.json",
  "name": "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."
        }
      ]
    }
  }
}