Container for the request parameters to the UpdateDomain operation.

See: newUpdateDomainConfig smart constructor.

Create a value of UpdateDomainConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateDomainConfig, updateDomainConfig_accessPolicies - Identity and Access Management (IAM) access policy as a JSON-formatted string.

UpdateDomainConfig, updateDomainConfig_advancedOptions - 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 allocated to field data. Default is unbounded.
• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

UpdateDomainConfig, updateDomainConfig_advancedSecurityOptions - Options for fine-grained access control.

UpdateDomainConfig, updateDomainConfig_autoTuneOptions - Options for Auto-Tune.

UpdateDomainConfig, updateDomainConfig_clusterConfig - Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

UpdateDomainConfig, updateDomainConfig_cognitoOptions - Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

UpdateDomainConfig, updateDomainConfig_domainEndpointOptions - Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

$sel:dryRun:UpdateDomainConfig', updateDomainConfig_dryRun - This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

UpdateDomainConfig, updateDomainConfig_eBSOptions - The type and size of the EBS volume to attach to instances in the domain.

UpdateDomainConfig, updateDomainConfig_encryptionAtRestOptions - Encryption at rest options for the domain.

UpdateDomainConfig, updateDomainConfig_logPublishingOptions - Options to publish OpenSearch lots to Amazon CloudWatch Logs.

UpdateDomainConfig, updateDomainConfig_nodeToNodeEncryptionOptions - Node-To-Node Encryption options for the domain.

UpdateDomainConfig, updateDomainConfig_snapshotOptions - Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

UpdateDomainConfig, updateDomainConfig_vPCOptions - Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

UpdateDomainConfig, updateDomainConfig_domainName - The name of the domain that you're updating.

Identity and Access Management (IAM) access policy as a JSON-formatted string.

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 allocated to field data. Default is unbounded.
• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

Options for fine-grained access control.

Options for Auto-Tune.

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

The type and size of the EBS volume to attach to instances in the domain.

Encryption at rest options for the domain.

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

Node-To-Node Encryption options for the domain.

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

The name of the domain that you're updating.

The results of an UpdateDomain request. Contains the status of the domain being updated.

See: newUpdateDomainConfigResponse smart constructor.

Create a value of UpdateDomainConfigResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRunResults:UpdateDomainConfigResponse', updateDomainConfigResponse_dryRunResults - Results of a dry run performed in an update domain request.

$sel:httpStatus:UpdateDomainConfigResponse', updateDomainConfigResponse_httpStatus - The response's http status code.

$sel:domainConfig:UpdateDomainConfigResponse', updateDomainConfigResponse_domainConfig - The status of the updated domain.

Results of a dry run performed in an update domain request.

The response's http status code.

The status of the updated domain.