Amazon OpenSearch Service API · Schema
UpdateElasticsearchDomainConfigRequest
AnalyticsAmazon Web ServicesElasticsearchSearch
Properties
| Name | Type | Description |
|---|---|---|
| DomainName | string | The name of the Elasticsearch domain that you are updating. |
| ElasticsearchClusterConfig | object | |
| EBSOptions | object | |
| SnapshotOptions | object | |
| VPCOptions | object | |
| CognitoOptions | object | |
| AdvancedOptions | object | Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration |
| AccessPolicies | string | IAM access policy as a JSON-formatted string. |
| LogPublishingOptions | object | Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log. |
| DomainEndpointOptions | object | |
| AdvancedSecurityOptions | object | |
| NodeToNodeEncryptionOptions | object | |
| EncryptionAtRestOptions | object | |
| AutoTuneOptions | object | |
| DryRun | boolean | This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, s |
| 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. For valid values and requirements, see DomainEngineMode. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/amazon-opensearch/json-schema/amazon-opensearch-update-elasticsearch-domain-config-request-schema.json",
"title": "UpdateElasticsearchDomainConfigRequest",
"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/UpdateElasticsearchDomainConfigRequest",
"type": "object",
"properties": {
"DomainName": {
"type": "string",
"description": "The name of the Elasticsearch domain that you are updating."
},
"ElasticsearchClusterConfig": {
"$ref": "#/$defs/ElasticsearchClusterConfig"
},
"EBSOptions": {
"$ref": "#/$defs/EsEBSOptions"
},
"SnapshotOptions": {
"$ref": "#/$defs/EsSnapshotOptions"
},
"VPCOptions": {
"$ref": "#/$defs/EsVPCOptions"
},
"CognitoOptions": {
"$ref": "#/$defs/EsCognitoOptions"
},
"AdvancedOptions": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information."
},
"AccessPolicies": {
"type": "string",
"description": "IAM access policy as a JSON-formatted string."
},
"LogPublishingOptions": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/EsLogPublishingOption"
},
"description": "Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log."
},
"DomainEndpointOptions": {
"$ref": "#/$defs/EsDomainEndpointOptions"
},
"AdvancedSecurityOptions": {
"$ref": "#/$defs/EsAdvancedSecurityOptionsInput"
},
"NodeToNodeEncryptionOptions": {
"$ref": "#/$defs/EsNodeToNodeEncryptionOptions"
},
"EncryptionAtRestOptions": {
"$ref": "#/$defs/EsEncryptionAtRestOptions"
},
"AutoTuneOptions": {
"$ref": "#/$defs/EsAutoTuneOptions"
},
"DryRun": {
"type": "boolean",
"description": "This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update."
},
"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. For valid values and requirements, see DomainEngineMode."
}
},
"required": [
"DomainName"
],
"$defs": {
"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"
]
},
"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"
]
},
"ElasticsearchClusterConfig": {
"type": "object",
"properties": {
"InstanceType": {
"type": "string",
"enum": [
"m3.medium.elasticsearch",
"m3.large.elasticsearch",
"m3.xlarge.elasticsearch",
"m3.2xlarge.elasticsearch",
"m4.large.elasticsearch",
"m4.xlarge.elasticsearch",
"m4.2xlarge.elasticsearch",
"m4.4xlarge.elasticsearch",
"m4.10xlarge.elasticsearch",
"m5.large.elasticsearch",
"m5.xlarge.elasticsearch",
"m5.2xlarge.elasticsearch",
"m5.4xlarge.elasticsearch",
"m5.12xlarge.elasticsearch",
"r5.large.elasticsearch",
"r5.xlarge.elasticsearch",
"r5.2xlarge.elasticsearch",
"r5.4xlarge.elasticsearch",
"r5.12xlarge.elasticsearch",
"c5.large.elasticsearch",
"c5.xlarge.elasticsearch",
"c5.2xlarge.elasticsearch",
"c5.4xlarge.elasticsearch",
"c5.9xlarge.elasticsearch",
"c5.18xlarge.elasticsearch",
"ultrawarm1.medium.elasticsearch",
"ultrawarm1.large.elasticsearch",
"t2.micro.elasticsearch",
"t2.small.elasticsearch",
"t2.medium.elasticsearch",
"r3.large.elasticsearch",
"r3.xlarge.elasticsearch",
"r3.2xlarge.elasticsearch",
"r3.4xlarge.elasticsearch",
"r3.8xlarge.elasticsearch",
"i2.xlarge.elasticsearch",
"i2.2xlarge.elasticsearch",
"d2.xlarge.elasticsearch",
"d2.2xlarge.elasticsearch",
"d2.4xlarge.elasticsearch",
"d2.8xlarge.elasticsearch",
"c4.large.elasticsearch",
"c4.xlarge.elasticsearch",
"c4.2xlarge.elasticsearch",
"c4.4xlarge.elasticsearch",
"c4.8xlarge.elasticsearch",
"r4.large.elasticsearch",
"r4.xlarge.elasticsearch",
"r4.2xlarge.elasticsearch",
"r4.4xlarge.elasticsearch",
"r4.8xlarge.elasticsearch",
"r4.16xlarge.elasticsearch",
"i3.large.elasticsearch",
"i3.xlarge.elasticsearch",
"i3.2xlarge.elasticsearch",
"i3.4xlarge.elasticsearch",
"i3.8xlarge.elasticsearch",
"i3.16xlarge.elasticsearch"
],
"description": "The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances."
},
"InstanceCount": {
"type": "integer",
"description": "The number of instances in the specified domain cluster."
},
"DedicatedMasterEnabled": {
"type": "boolean",
"description": "A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information."
},
"ZoneAwarenessEnabled": {
"type": "boolean",
"description": "A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information."
},
"ZoneAwarenessConfig": {
"$ref": "#/$defs/EsZoneAwarenessConfig"
},
"DedicatedMasterType": {
"type": "string",
"enum": [
"m3.medium.elasticsearch",
"m3.large.elasticsearch",
"m3.xlarge.elasticsearch",
"m3.2xlarge.elasticsearch",
"m4.large.elasticsearch",
"m4.xlarge.elasticsearch",
"m4.2xlarge.elasticsearch",
"m4.4xlarge.elasticsearch",
"m4.10xlarge.elasticsearch",
"m5.large.elasticsearch",
"m5.xlarge.elasticsearch",
"m5.2xlarge.elasticsearch",
"m5.4xlarge.elasticsearch",
"m5.12xlarge.elasticsearch",
"r5.large.elasticsearch",
"r5.xlarge.elasticsearch",
"r5.2xlarge.elasticsearch",
"r5.4xlarge.elasticsearch",
"r5.12xlarge.elasticsearch",
"c5.large.elasticsearch",
"c5.xlarge.elasticsearch",
"c5.2xlarge.elasticsearch",
"c5.4xlarge.elasticsearch",
"c5.9xlarge.elasticsearch",
"c5.18xlarge.elasticsearch",
"ultrawarm1.medium.elasticsearch",
"ultrawarm1.large.elasticsearch",
"t2.micro.elasticsearch",
"t2.small.elasticsearch",
"t2.medium.elasticsearch",
"r3.large.elasticsearch",
"r3.xlarge.elasticsearch",
"r3.2xlarge.elasticsearch",
"r3.4xlarge.elasticsearch",
"r3.8xlarge.elasticsearch",
"i2.xlarge.elasticsearch",
"i2.2xlarge.elasticsearch",
"d2.xlarge.elasticsearch",
"d2.2xlarge.elasticsearch",
"d2.4xlarge.elasticsearch",
"d2.8xlarge.elasticsearch",
"c4.large.elasticsearch",
"c4.xlarge.elasticsearch",
"c4.2xlarge.elasticsearch",
"c4.4xlarge.elasticsearch",
"c4.8xlarge.elasticsearch",
"r4.large.elasticsearch",
"r4.xlarge.elasticsearch",
"r4.2xlarge.elasticsearch",
"r4.4xlarge.elasticsearch",
"r4.8xlarge.elasticsearch",
"r4.16xlarge.elasticsearch",
"i3.large.elasticsearch",
"i3.xlarge.elasticsearch",
"i3.2xlarge.elasticsearch",
"i3.4xlarge.elasticsearch",
"i3.8xlarge.elasticsearch",
"i3.16xlarge.elasticsearch"
],
"description": "The instance type for a dedicated master node."
},
"DedicatedMasterCount": {
"type": "integer",
"description": "Total number of dedicated master nodes, active and on standby, for the cluster."
},
"WarmEnabled": {
"type": "boolean",
"description": "True to enable warm storage."
},
"WarmType": {
"type": "string",
"enum": [
"ultrawarm1.medium.elasticsearch",
"ultrawarm1.large.elasticsearch"
],
"description": "The instance type for the Elasticsearch cluster's warm nodes."
},
"WarmCount": {
"type": "integer",
"description": "The number of warm nodes in the cluster."
},
"ColdStorageOptions": {
"$ref": "#/$defs/EsColdStorageOptions"
}
}
},
"EsAdvancedSecurityOptionsInput": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "True if advanced security is enabled."
},
"InternalUserDatabaseEnabled": {
"type": "boolean",
"description": "True if the internal user database is enabled."
},
"MasterUserOptions": {
"$ref": "#/$defs/EsMasterUserOptions"
},
"SAMLOptions": {
"$ref": "#/$defs/EsSAMLOptionsInput"
},
"AnonymousAuthEnabled": {
"type": "boolean",
"description": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains."
}
}
},
"EsAutoTuneMaintenanceSchedule": {
"type": "object",
"properties": {
"StartAt": {
"type": "string",
"format": "date-time",
"description": "Specifies timestamp at which Auto-Tune maintenance schedule start."
},
"Duration": {
"$ref": "#/$defs/EsDuration"
},
"CronExpressionForRecurrence": {
"type": "string",
"description": "Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information."
}
}
},
"EsAutoTuneOptions": {
"type": "object",
"properties": {
"DesiredState": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
],
"description": "Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED."
},
"RollbackOnDisable": {
"type": "string",
"enum": [
"NO_ROLLBACK",
"DEFAULT_ROLLBACK"
],
"description": "Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK."
},
"MaintenanceSchedules": {
"type": "array",
"items": {
"$ref": "#/$defs/EsAutoTuneMaintenanceSchedule"
},
"description": "Specifies list of maitenance schedules. See the Developer Guide for more information."
}
}
},
"EsCognitoOptions": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Specifies the option to enable Cognito for Kibana authentication."
},
"UserPoolId": {
"type": "string",
"description": "Specifies the Cognito user pool ID for Kibana authentication."
},
"IdentityPoolId": {
"type": "string",
"description": "Specifies the Cognito identity pool ID for Kibana authentication."
},
"RoleArn": {
"type": "string",
"description": "Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources."
}
}
},
"EsColdStorageOptions": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Enable cold storage option. Accepted values true or false"
}
},
"required": [
"Enabled"
]
},
"EsDomainEndpointOptions": {
"type": "object",
"properties": {
"EnforceHTTPS": {
"type": "boolean",
"description": "Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain."
},
"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"
],
"description": "Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It 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"
},
"CustomEndpointEnabled": {
"type": "boolean",
"description": "Specify if custom endpoint should be enabled for the Elasticsearch domain."
},
"CustomEndpoint": {
"type": "string",
"description": "Specify the fully qualified domain for your custom endpoint."
},
"CustomEndpointCertificateArn": {
"type": "string",
"description": "Specify ACM certificate ARN for your custom endpoint."
}
}
},
"EsDuration": {
"type": "object",
"properties": {
"Value": {
"type": "integer",
"description": "Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information."
},
"Unit": {
"type": "string",
"enum": [
"HOURS"
],
"description": "Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information."
}
}
},
"EsEBSOptions": {
"type": "object",
"properties": {
"EBSEnabled": {
"type": "boolean",
"description": "Specifies whether EBS-based storage is enabled."
},
"VolumeType": {
"type": "string",
"enum": [
"standard",
"gp2",
"io1",
"gp3"
],
"description": "Specifies the volume type for EBS-based storage."
},
"VolumeSize": {
"type": "integer",
"description": "Integer to specify the size of an EBS volume."
},
"Iops": {
"type": "integer",
"description": "Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD)."
},
"Throughput": {
"type": "integer",
"description": "Specifies the Throughput for GP3 EBS volume (SSD)."
}
}
},
"EsEncryptionAtRestOptions": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Specifies the option to enable Encryption At Rest."
},
"KmsKeyId": {
"type": "string",
"description": "Specifies the KMS Key ID for Encryption At Rest options."
}
}
},
"EsLogPublishingOption": {
"type": "object",
"properties": {
"CloudWatchLogsLogGroupArn": {
"type": "string"
},
"Enabled": {
"type": "boolean",
"description": "Specifies whether given log publishing option is enabled or not."
}
}
},
"EsMasterUserOptions": {
"type": "object",
"properties": {
"MasterUserARN": {
"type": "string",
"description": "ARN for the master user (if IAM is enabled)."
},
"MasterUserName": {
"type": "string",
"description": "The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database."
},
"MasterUserPassword": {
"type": "string",
"description": "The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database."
}
}
},
"EsNodeToNodeEncryptionOptions": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "Specify true to enable node-to-node encryption."
}
}
},
"EsSAMLIdp": {
"type": "object",
"properties": {
"MetadataContent": {
"type": "string",
"description": "The Metadata of the SAML application in xml format."
},
"EntityId": {
"type": "string",
"description": "The unique Entity ID of the application in SAML Identity Provider."
}
},
"required": [
"MetadataContent",
"EntityId"
]
},
"EsSAMLOptionsInput": {
"type": "object",
"properties": {
"Enabled": {
"type": "boolean",
"description": "True if SAML is enabled."
},
"Idp": {
"$ref": "#/$defs/EsSAMLIdp"
},
"MasterUserName": {
"type": "string",
"description": "The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database."
},
"MasterBackendRole": {
"type": "string",
"description": "The backend role to which the SAML master user is mapped to."
},
"SubjectKey": {
"type": "string",
"description": "The key to use for matching the SAML Subject attribute."
},
"RolesKey": {
"type": "string",
"description": "The key to use for matching the SAML Roles attribute."
},
"SessionTimeoutMinutes": {
"type": "integer",
"description": "The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60."
}
}
},
"EsSnapshotOptions": {
"type": "object",
"properties": {
"AutomatedSnapshotStartHour": {
"type": "integer",
"description": "Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours."
}
}
},
"EsVPCOptions": {
"type": "object",
"properties": {
"SubnetIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the subnets for VPC endpoint."
},
"SecurityGroupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the security groups for VPC endpoint."
}
}
},
"EsZoneAwarenessConfig": {
"type": "object",
"properties": {
"AvailabilityZoneCount": {
"type": "integer",
"description": "An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled"
}
}
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-opensearch-update-elasticsearch-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.