UpdateDomainConfigRequest

AnalyticsAmazon Web ServicesElasticsearchSearch

Properties

Name Type Description
DomainName string The name of the domain that you're updating.
ClusterConfig object
EBSOptions object
SnapshotOptions object
VPCOptions object
CognitoOptions object
AdvancedOptions object Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather tha
AccessPolicies string Identity and Access Management (IAM) access policy as a JSON-formatted string.
IPAddressType string Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is
LogPublishingOptions object Options to publish OpenSearch logs to Amazon CloudWatch Logs.
EncryptionAtRestOptions object
DomainEndpointOptions object
NodeToNodeEncryptionOptions object
AdvancedSecurityOptions object
IdentityCenterOptions object
AutoTuneOptions object
DryRun boolean This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployme
DryRunMode string The type of dry run to perform. Basic only returns the type of deployment (blue/green or dynamic) that the update will cause. Verbose runs an additional check to validate the changes you're making. Fo
OffPeakWindowOptions object
SoftwareUpdateOptions object
AIMLOptions object
DeploymentStrategyOptions object
AutomatedSnapshotPauseOptions object
UseCase string The primary use case for the domain. For valid values, see DomainUseCase.
EngineMode string The engine mode for the domain. The engine mode can't be changed after the domain is created. For valid values, see EngineMode.
AcceptedWarnings array A list of advisory warning codes to accept for this configuration change. By default, any advisory warning blocks the change. Include the code of each warning you want to accept so the change can proc
View JSON Schema on GitHub

JSON Schema

amazon-opensearch-update-domain-config-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-domain-config-request-schema.json",
  "title": "UpdateDomainConfigRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-opensearch-config-api-openapi.yml#/components/schemas/UpdateDomainConfigRequest",
  "type": "object",
  "properties": {
    "DomainName": {
      "type": "string",
      "description": "The name of the domain that you're updating."
    },
    "ClusterConfig": {
      "$ref": "#/$defs/ClusterConfig"
    },
    "EBSOptions": {
      "$ref": "#/$defs/EBSOptions"
    },
    "SnapshotOptions": {
      "$ref": "#/$defs/SnapshotOptions"
    },
    "VPCOptions": {
      "$ref": "#/$defs/VPCOptions"
    },
    "CognitoOptions": {
      "$ref": "#/$defs/CognitoOptions"
    },
    "AdvancedOptions": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: \"rest.action.multi.allow_explicit_index\": \"true\" | \"false\" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. \"indices.fielddata.cache.size\": \"80\" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocate"
    },
    "AccessPolicies": {
      "type": "string",
      "description": "Identity and Access Management (IAM) access policy as a JSON-formatted string."
    },
    "IPAddressType": {
      "type": "string",
      "enum": [
        "ipv4",
        "dualstack"
      ],
      "description": "Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it."
    },
    "LogPublishingOptions": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/LogPublishingOption"
      },
      "description": "Options to publish OpenSearch logs to Amazon CloudWatch Logs."
    },
    "EncryptionAtRestOptions": {
      "$ref": "#/$defs/EncryptionAtRestOptions"
    },
    "DomainEndpointOptions": {
      "$ref": "#/$defs/DomainEndpointOptions"
    },
    "NodeToNodeEncryptionOptions": {
      "$ref": "#/$defs/NodeToNodeEncryptionOptions"
    },
    "AdvancedSecurityOptions": {
      "$ref": "#/$defs/AdvancedSecurityOptionsInput"
    },
    "IdentityCenterOptions": {
      "$ref": "#/$defs/IdentityCenterOptionsInput"
    },
    "AutoTuneOptions": {
      "$ref": "#/$defs/AutoTuneOptions"
    },
    "DryRun": {
      "type": "boolean",
      "description": "This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause."
    },
    "DryRunMode": {
      "type": "string",
      "enum": [
        "Basic",
        "Verbose"
      ],
      "description": "The type of dry run to perform. Basic only returns the type of deployment (blue/green or dynamic) that the update will cause. Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update."
    },
    "OffPeakWindowOptions": {
      "$ref": "#/$defs/OffPeakWindowOptions"
    },
    "SoftwareUpdateOptions": {
      "$ref": "#/$defs/SoftwareUpdateOptions"
    },
    "AIMLOptions": {
      "$ref": "#/$defs/AIMLOptionsInput"
    },
    "DeploymentStrategyOptions": {
      "$ref": "#/$defs/DeploymentStrategyOptions"
    },
    "AutomatedSnapshotPauseOptions": {
      "$ref": "#/$defs/AutomatedSnapshotPauseRequestOptions"
    },
    "UseCase": {
      "type": "string",
      "enum": [
        "SEARCH",
        "VECTOR",
        "OBSERVABILITY",
        "MIXED"
      ],
      "description": "The primary use case for the domain. For valid values, see DomainUseCase."
    },
    "EngineMode": {
      "type": "string",
      "enum": [
        "GENERAL",
        "OPTIMIZED"
      ],
      "description": "The engine mode for the domain. The engine mode can't be changed after the domain is created. For valid values, see EngineMode."
    },
    "AcceptedWarnings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of advisory warning codes to accept for this configuration change. By default, any advisory warning blocks the change. Include the code of each warning you want to accept so the change can proceed. You can find warning codes in the ValidationFailures list returned by DescribeDomainChangeProgress and DescribeDryRunProgress. Critical validation failures cannot be accepted and always block the change. If you omit this parameter or pass an empty list, all warnings block the change. For more information, see Validating a domain update."
    }
  },
  "required": [
    "DomainName"
  ],
  "$defs": {
    "AIMLOptionsInput": {
      "type": "object",
      "properties": {
        "NaturalLanguageQueryGenerationOptions": {
          "$ref": "#/$defs/NaturalLanguageQueryGenerationOptionsInput"
        },
        "S3VectorsEngine": {
          "$ref": "#/$defs/S3VectorsEngine"
        },
        "ServerlessVectorAcceleration": {
          "$ref": "#/$defs/ServerlessVectorAcceleration"
        }
      }
    },
    "AdvancedSecurityOptionsInput": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "True to enable fine-grained access control."
        },
        "InternalUserDatabaseEnabled": {
          "type": "boolean",
          "description": "True to enable the internal user database."
        },
        "MasterUserOptions": {
          "$ref": "#/$defs/MasterUserOptions"
        },
        "SAMLOptions": {
          "$ref": "#/$defs/SAMLOptionsInput"
        },
        "JWTOptions": {
          "$ref": "#/$defs/JWTOptionsInput"
        },
        "IAMFederationOptions": {
          "$ref": "#/$defs/IAMFederationOptionsInput"
        },
        "AnonymousAuthEnabled": {
          "type": "boolean",
          "description": "True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain."
        }
      }
    },
    "AutoTuneMaintenanceSchedule": {
      "type": "object",
      "properties": {
        "StartAt": {
          "type": "string",
          "format": "date-time",
          "description": "The Epoch timestamp at which the Auto-Tune maintenance schedule starts."
        },
        "Duration": {
          "$ref": "#/$defs/Duration"
        },
        "CronExpressionForRecurrence": {
          "type": "string",
          "description": "A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes."
        }
      }
    },
    "AutoTuneOptions": {
      "type": "object",
      "properties": {
        "DesiredState": {
          "type": "string",
          "enum": [
            "ENABLED",
            "DISABLED"
          ],
          "description": "Whether Auto-Tune is enabled or disabled."
        },
        "RollbackOnDisable": {
          "type": "string",
          "enum": [
            "NO_ROLLBACK",
            "DEFAULT_ROLLBACK"
          ],
          "description": "When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback."
        },
        "MaintenanceSchedules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AutoTuneMaintenanceSchedule"
          },
          "description": "DEPRECATED. Use off-peak window instead. A list of maintenance schedules during which Auto-Tune can deploy changes."
        },
        "UseOffPeakWindow": {
          "type": "boolean",
          "description": "Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule."
        }
      }
    },
    "AutomatedSnapshotPauseRequestOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether to enable or disable automated snapshot pause for the domain."
        },
        "StartTime": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp at which the automated snapshot pause should begin."
        },
        "EndTime": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp at which the automated snapshot pause should end. The maximum allowed duration between StartTime and EndTime is 3 days."
        }
      },
      "required": [
        "Enabled"
      ]
    },
    "ClusterConfig": {
      "type": "object",
      "properties": {
        "InstanceType": {
          "type": "string",
          "enum": [
            "m3.medium.search",
            "m3.large.search",
            "m3.xlarge.search",
            "m3.2xlarge.search",
            "m4.large.search",
            "m4.xlarge.search",
            "m4.2xlarge.search",
            "m4.4xlarge.search",
            "m4.10xlarge.search",
            "m5.large.search",
            "m5.xlarge.search",
            "m5.2xlarge.search",
            "m5.4xlarge.search",
            "m5.12xlarge.search",
            "m5.24xlarge.search",
            "r5.large.search",
            "r5.xlarge.search",
            "r5.2xlarge.search",
            "r5.4xlarge.search",
            "r5.12xlarge.search",
            "r5.24xlarge.search",
            "c5.large.search",
            "c5.xlarge.search",
            "c5.2xlarge.search",
            "c5.4xlarge.search",
            "c5.9xlarge.search",
            "c5.18xlarge.search",
            "t3.nano.search",
            "t3.micro.search",
            "t3.small.search",
            "t3.medium.search",
            "t3.large.search",
            "t3.xlarge.search",
            "t3.2xlarge.search",
            "or1.medium.search",
            "or1.large.search",
            "or1.xlarge.search",
            "or1.2xlarge.search",
            "or1.4xlarge.search",
            "or1.8xlarge.search",
            "or1.12xlarge.search",
            "or1.16xlarge.search",
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search",
            "t2.micro.search",
            "t2.small.search",
            "t2.medium.search",
            "r3.large.search",
            "r3.xlarge.search",
            "r3.2xlarge.search",
            "r3.4xlarge.search",
            "r3.8xlarge.search",
            "i2.xlarge.search",
            "i2.2xlarge.search",
            "d2.xlarge.search",
            "d2.2xlarge.search",
            "d2.4xlarge.search",
            "d2.8xlarge.search",
            "c4.large.search",
            "c4.xlarge.search",
            "c4.2xlarge.search",
            "c4.4xlarge.search",
            "c4.8xlarge.search",
            "r4.large.search",
            "r4.xlarge.search",
            "r4.2xlarge.search",
            "r4.4xlarge.search",
            "r4.8xlarge.search",
            "r4.16xlarge.search",
            "i3.large.search",
            "i3.xlarge.search",
            "i3.2xlarge.search",
            "i3.4xlarge.search",
            "i3.8xlarge.search",
            "i3.16xlarge.search",
            "r6g.large.search",
            "r6g.xlarge.search",
            "r6g.2xlarge.search",
            "r6g.4xlarge.search",
            "r6g.8xlarge.search",
            "r6g.12xlarge.search",
            "m6g.large.search",
            "m6g.xlarge.search",
            "m6g.2xlarge.search",
            "m6g.4xlarge.search",
            "m6g.8xlarge.search",
            "m6g.12xlarge.search",
            "c6g.large.search",
            "c6g.xlarge.search",
            "c6g.2xlarge.search",
            "c6g.4xlarge.search",
            "c6g.8xlarge.search",
            "c6g.12xlarge.search",
            "r6gd.large.search",
            "r6gd.xlarge.search",
            "r6gd.2xlarge.search",
            "r6gd.4xlarge.search",
            "r6gd.8xlarge.search",
            "r6gd.12xlarge.search",
            "r6gd.16xlarge.search",
            "t4g.small.search",
            "t4g.medium.search"
          ],
          "description": "Instance type of data nodes in the cluster."
        },
        "InstanceCount": {
          "type": "integer",
          "description": "Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception."
        },
        "DedicatedMasterEnabled": {
          "type": "boolean",
          "description": "Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not."
        },
        "ZoneAwarenessEnabled": {
          "type": "boolean",
          "description": "Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service."
        },
        "ZoneAwarenessConfig": {
          "$ref": "#/$defs/ZoneAwarenessConfig"
        },
        "DedicatedMasterType": {
          "type": "string",
          "enum": [
            "m3.medium.search",
            "m3.large.search",
            "m3.xlarge.search",
            "m3.2xlarge.search",
            "m4.large.search",
            "m4.xlarge.search",
            "m4.2xlarge.search",
            "m4.4xlarge.search",
            "m4.10xlarge.search",
            "m5.large.search",
            "m5.xlarge.search",
            "m5.2xlarge.search",
            "m5.4xlarge.search",
            "m5.12xlarge.search",
            "m5.24xlarge.search",
            "r5.large.search",
            "r5.xlarge.search",
            "r5.2xlarge.search",
            "r5.4xlarge.search",
            "r5.12xlarge.search",
            "r5.24xlarge.search",
            "c5.large.search",
            "c5.xlarge.search",
            "c5.2xlarge.search",
            "c5.4xlarge.search",
            "c5.9xlarge.search",
            "c5.18xlarge.search",
            "t3.nano.search",
            "t3.micro.search",
            "t3.small.search",
            "t3.medium.search",
            "t3.large.search",
            "t3.xlarge.search",
            "t3.2xlarge.search",
            "or1.medium.search",
            "or1.large.search",
            "or1.xlarge.search",
            "or1.2xlarge.search",
            "or1.4xlarge.search",
            "or1.8xlarge.search",
            "or1.12xlarge.search",
            "or1.16xlarge.search",
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search",
            "t2.micro.search",
            "t2.small.search",
            "t2.medium.search",
            "r3.large.search",
            "r3.xlarge.search",
            "r3.2xlarge.search",
            "r3.4xlarge.search",
            "r3.8xlarge.search",
            "i2.xlarge.search",
            "i2.2xlarge.search",
            "d2.xlarge.search",
            "d2.2xlarge.search",
            "d2.4xlarge.search",
            "d2.8xlarge.search",
            "c4.large.search",
            "c4.xlarge.search",
            "c4.2xlarge.search",
            "c4.4xlarge.search",
            "c4.8xlarge.search",
            "r4.large.search",
            "r4.xlarge.search",
            "r4.2xlarge.search",
            "r4.4xlarge.search",
            "r4.8xlarge.search",
            "r4.16xlarge.search",
            "i3.large.search",
            "i3.xlarge.search",
            "i3.2xlarge.search",
            "i3.4xlarge.search",
            "i3.8xlarge.search",
            "i3.16xlarge.search",
            "r6g.large.search",
            "r6g.xlarge.search",
            "r6g.2xlarge.search",
            "r6g.4xlarge.search",
            "r6g.8xlarge.search",
            "r6g.12xlarge.search",
            "m6g.large.search",
            "m6g.xlarge.search",
            "m6g.2xlarge.search",
            "m6g.4xlarge.search",
            "m6g.8xlarge.search",
            "m6g.12xlarge.search",
            "c6g.large.search",
            "c6g.xlarge.search",
            "c6g.2xlarge.search",
            "c6g.4xlarge.search",
            "c6g.8xlarge.search",
            "c6g.12xlarge.search",
            "r6gd.large.search",
            "r6gd.xlarge.search",
            "r6gd.2xlarge.search",
            "r6gd.4xlarge.search",
            "r6gd.8xlarge.search",
            "r6gd.12xlarge.search",
            "r6gd.16xlarge.search",
            "t4g.small.search",
            "t4g.medium.search"
          ],
          "description": "OpenSearch Service instance type of the dedicated master nodes in the cluster."
        },
        "DedicatedMasterCount": {
          "type": "integer",
          "description": "Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception."
        },
        "WarmEnabled": {
          "type": "boolean",
          "description": "Whether to enable warm storage for the cluster."
        },
        "WarmType": {
          "type": "string",
          "enum": [
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search"
          ],
          "description": "The instance type for the cluster's warm nodes."
        },
        "WarmCount": {
          "type": "integer",
          "description": "The number of warm nodes in the cluster."
        },
        "ColdStorageOptions": {
          "$ref": "#/$defs/ColdStorageOptions"
        },
        "MultiAZWithStandbyEnabled": {
          "type": "boolean",
          "description": "A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service."
        },
        "NodeOptions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NodeOption"
          },
          "description": "List of node options for the domain."
        }
      }
    },
    "CognitoOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards."
        },
        "UserPoolId": {
          "type": "string",
          "description": "The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication."
        },
        "IdentityPoolId": {
          "type": "string",
          "description": "The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication."
        },
        "RoleArn": {
          "type": "string",
          "description": "The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool."
        }
      }
    },
    "ColdStorageOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage."
        }
      },
      "required": [
        "Enabled"
      ]
    },
    "DeploymentStrategyOptions": {
      "type": "object",
      "properties": {
        "DeploymentStrategy": {
          "type": "string",
          "enum": [
            "Default",
            "CapacityOptimized"
          ],
          "description": "Specifies the deployment strategy for the domain. Valid values are Default and CapacityOptimized."
        }
      },
      "required": [
        "DeploymentStrategy"
      ]
    },
    "DomainEndpointOptions": {
      "type": "object",
      "properties": {
        "EnforceHTTPS": {
          "type": "boolean",
          "description": "True to require that all traffic to the domain arrive over HTTPS."
        },
        "TLSSecurityPolicy": {
          "type": "string",
          "enum": [
            "Policy-Min-TLS-1-0-2019-07",
            "Policy-Min-TLS-1-2-2019-07",
            "Policy-Min-TLS-1-2-PFS-2023-10",
            "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08",
            "Policy-Min-TLS-1-2-FIPS-PQ-2026-10"
          ],
          "description": "Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS Policy-Min-TLS-1-2-FIPS-PQ-2026-10: TLS security p"
        },
        "CustomEndpointEnabled": {
          "type": "boolean",
          "description": "Whether to enable a custom endpoint for the domain."
        },
        "CustomEndpoint": {
          "type": "string",
          "description": "The fully qualified URL for the custom endpoint."
        },
        "CustomEndpointCertificateArn": {
          "type": "string",
          "description": "The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM)."
        }
      }
    },
    "Duration": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "integer",
          "description": "Integer to specify the value of a maintenance schedule duration."
        },
        "Unit": {
          "type": "string",
          "enum": [
            "HOURS"
          ],
          "description": "The unit of measurement for the duration of a maintenance schedule."
        }
      }
    },
    "EBSOptions": {
      "type": "object",
      "properties": {
        "EBSEnabled": {
          "type": "boolean",
          "description": "Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain."
        },
        "VolumeType": {
          "type": "string",
          "enum": [
            "standard",
            "gp2",
            "io1",
            "gp3"
          ],
          "description": "Specifies the type of EBS volumes attached to data nodes."
        },
        "VolumeSize": {
          "type": "integer",
          "description": "Specifies the size (in GiB) of EBS volumes attached to data nodes."
        },
        "Iops": {
          "type": "integer",
          "description": "Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types."
        },
        "Throughput": {
          "type": "integer",
          "description": "Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type."
        }
      }
    },
    "EncryptionAtRestOptions": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "True to enable encryption at rest."
        },
        "KmsKeyId": {
          "type": "string",
          "description": "The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a."
        },
        "EncryptionMode": {
          "type": "string",
          "enum": [
            "DISK",
            "NATIVE"
          ],
          "description": "The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK."
        }
      }
    },
    "IAMFederationOptionsInput": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "Specifies whether IAM identity federation is enabled for the OpenSearch domain."
        },
        "SubjectKey": {
          "type": "string",
          "description": "The key in the SAML assertion that contains the user's subject identifier."
        },
        "RolesKey": {
          "type": "string",
          "description": "The key in the SAML assertion that contains the user's role information."
        }
      }
    },
    "IdentityCenterOptionsInput": {
      "type": "object",
      "properties": {
        "EnabledAPIAccess": {
          "type": "boolean",
          "description": "Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service."
        },
        "IdentityCenterInstanceARN": {
          "type": "string",
          "description": "The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication."
        },
        "IdentityCenterInstanceRegion": {
          "type": "string",
          "description": "The Region of the IAM Identity Center instance."
        },
        "SubjectKey": {
          "type": "string",
          "enum": [
            "UserName",
            "UserId",
            "Email"
          ],
          "description": "Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center."
        },
        "RolesKey": {
          "type": "string",
          "enum": [
            "GroupName",
            "GroupId"
          ],
          "description": "Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center."
        }
      }
    },
    "JWTOptionsInput": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "True to enable JWT authentication and authorization for a domain."
        },
        "SubjectKey": {
          "type": "string",
          "description": "Element of the JWT assertion to use for the user name."
        },
        "RolesKey": {
          "type": "string",
          "description": "Element of the JWT assertion to use for roles."
        },
        "JwksUrl": {
          "type": "string",
          "description": "The URL endpoint that hosts the JSON Web Key Set (JWKS) containing public keys used to verify JWT signatures."
        },
        "PublicKey": {
          "type": "string",
          "description": "Element of the JWT assertion used by the cluster to verify JWT signatures."
        }
      }
    },
    "LogPublishingOption": {
      "type": "object",
      "properties": {
        "CloudWatchLogsLogGroupArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to."
        },
        "Enabled": {
          "type": "boolean",
          "description": "Whether the log should be published."
        }
      }
    },
    "MasterUserOptions": {
      "type": "object",
      "properties": {
        "MasterUserARN": {
          "type": "string",
          "description": "Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false."
        },
        "MasterUserName": {
          "type": "string",
          "description": "User name for the master user. Only specify if InternalUserDatabaseEnabled is true."
        },
        "MasterUserPassword": {
          "type": "string",
          "description": "Password for the master user. Only specify if InternalUserDatabaseEnabled is true."
        }
      }
    },
    "NaturalLanguageQueryGenerationOptionsInput": {
      "type": "object",
      "properties": {
        "DesiredState": {
          "type": "string",
          "enum": [
            "ENABLED",
            "DISABLED"
          ],
          "description": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED."
        }
      }
    },
    "NodeConfig": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean",
          "description": "A boolean value indicating whether a specific node type is active or inactive."
        },
        "Type": {
          "type": "string",
          "enum": [
            "m3.medium.search",
            "m3.large.search",
            "m3.xlarge.search",
            "m3.2xlarge.search",
            "m4.large.search",
            "m4.xlarge.search",
            "m4.2xlarge.search",
            "m4.4xlarge.search",
            "m4.10xlarge.search",
            "m5.large.search",
            "m5.xlarge.search",
            "m5.2xlarge.search",
            "m5.4xlarge.search",
            "m5.12xlarge.search",
            "m5.24xlarge.search",
            "r5.large.search",
            "r5.xlarge.search",
            "r5.2xlarge.search",
            "r5.4xlarge.search",
            "r5.12xlarge.search",
            "r5.24xlarge.search",
            "c5.large.search",
            "c5.xlarge.search",
            "c5.2xlarge.search",
            "c5.4xlarge.search",
            "c5.9xlarge.search",
            "c5.18xlarge.search",
            "t3.nano.search",
            "t3.micro.search",
            "t3.small.search",
            "t3.medium.search",
            "t3.large.search",
            "t3.xlarge.search",
            "t3.2xlarge.search",
            "or1.medium.search",
            "or1.large.search",
            "or1.xlarge.search",
            "or1.2xlarge.search",
            "or1.4xlarge.search",
            "or1.8xlarge.search",
            "or1.12xlarge.search",
            "or1.16xlarge.search",
            "ultrawarm1.medium.search",
            "ultrawarm1.large.search",
            "ultrawarm1.xlarge.search",
            "t2.micro.search",
            "t2.small.search",
            "t2.medium.search",
            "r3.large.search",
            "r3.xlarge.search",
            "r3.2xlarge.search",
            "r3.4xlarge.search",
            "r3.8xlarge.search",
            "i2.xlarge.search",
            "i2.2xlarge.search",
            "d2.xlarge.search",
            "d2.2xlarge.search",
            "d2.4xlarge.search",
            "d2.8xlarge.search",
            "c4.large.search",
            "c4.xlarge.search",
            "c4.2xlarge.search",
            "c4.4xlarge.search",
            "c4.8xlarge.search",
            "r4.large.search",
            "r4.xlarge.search",
            "r4.2xlarge.search",
            "r4.4xlarge.search",
            "r4.8xlarge.search",
            "r4.16xlarge.search",
            "i3.large.search",
            "i3.xlarge.search",
            "i3.2xlarge.search",
            "i3.4xlarge.search",
            "i3.8xlarge.search",
            "i3.16xlarge.search",
            "r6g.large.search",
            "r6g.xlarge.search",
            "r6g.2xlarge.search",
            "r6g.4xlarge.search",
            "r6g.8xlarge.search",
            "r6g.12xlarge.search",
            "m6g.large.search",
            "m6g.xlarge.search",
            "m6g.2xlarge.search",
            "m6g.4xlarge.search",
            "m6g.8xlarge.search",
            "m6g.12xlarge.search",
            "c6g.large.search",
            "c6g.xlarge.search",
            "c6g.2xlarge.search",
            "c6g.4xlarge.search",
            "c6g.8xlarge.search",
            "c6g.12xlarge.search",
            "r6gd.large.search",
            "r6gd.xlarge.search",
            "r6gd.2xlarge.search",
            "r6gd.4xlarge.search",
            "r6gd.8xlarge.search",
            "r6gd.12xlarge.search",
            "r6gd.16xlarge.search",
            "t4g.small.search",
            "t4g.medium.search"
          ],
          "description": "The instance type of a particular node within the cluster."
        },
        "Count": {
          "type": "integer",
          "descript

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-domain-config-request-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-update-domain-config-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.