Amazon OpenSearch Service API · JSON Structure

Openapi Advanced Security Options Input Structure

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

Type: object Properties: 5
AnalyticsElasticsearchSearch

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

Properties

Enabled InternalUserDatabaseEnabled MasterUserOptions SAMLOptions AnonymousAuthEnabled

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-advanced-security-options-input-structure.json",
  "name": "AdvancedSecurityOptionsInput",
  "description": "Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).",
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "True if advanced security is enabled."
        }
      ]
    },
    "InternalUserDatabaseEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "True if the internal user database is enabled."
        }
      ]
    },
    "MasterUserOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MasterUserOptions"
        },
        {
          "description": "Credentials for the master user: username and password, ARN, or both."
        }
      ]
    },
    "SAMLOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SAMLOptionsInput"
        },
        {
          "description": "Specifies the SAML application configuration for the domain."
        }
      ]
    },
    "AnonymousAuthEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains."
        }
      ]
    }
  }
}