Skip to contents

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain

Source: R/opensearchservice_operations.R
opensearchservice_update_domain_config.Rd

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

See https://www.paws-r-sdk.com/docs/opensearchservice_update_domain_config/ for full documentation.

Usage

opensearchservice_update_domain_config(
  DomainName,
  ClusterConfig = NULL,
  EBSOptions = NULL,
  SnapshotOptions = NULL,
  VPCOptions = NULL,
  CognitoOptions = NULL,
  AdvancedOptions = NULL,
  AccessPolicies = NULL,
  IPAddressType = NULL,
  LogPublishingOptions = NULL,
  EncryptionAtRestOptions = NULL,
  DomainEndpointOptions = NULL,
  NodeToNodeEncryptionOptions = NULL,
  AdvancedSecurityOptions = NULL,
  IdentityCenterOptions = NULL,
  AutoTuneOptions = NULL,
  DryRun = NULL,
  DryRunMode = NULL,
  OffPeakWindowOptions = NULL,
  SoftwareUpdateOptions = NULL,
  AIMLOptions = NULL,
  DeploymentStrategyOptions = NULL,
  AutomatedSnapshotPauseOptions = NULL
)

Arguments

DomainName

[required] The name of the domain that you're updating.

ClusterConfig

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

EBSOptions

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

SnapshotOptions

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

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.

CognitoOptions

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

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.

For more information, see Advanced cluster parameters.

AccessPolicies

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

IPAddressType

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

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

EncryptionAtRestOptions

Encryption at rest options for the domain.

DomainEndpointOptions

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

NodeToNodeEncryptionOptions

Node-to-node encryption options for the domain.

AdvancedSecurityOptions

Options for fine-grained access control.

IdentityCenterOptions

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

AutoTuneOptions

Options for Auto-Tune.

DryRun

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

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

Off-peak window options for the domain.

SoftwareUpdateOptions

Service software update options for the domain.

AIMLOptions

Options for all machine learning features for the specified domain.

DeploymentStrategyOptions

Specifies the deployment strategy options for the domain.

AutomatedSnapshotPauseOptions

Specifies the automated snapshot pause options for the domain.

Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.

Maximum suspension duration: 3 days.