yc managed-opensearch cluster update
Written by
Updated at July 24, 2025
Update a managed OpenSearchCluster.
Command Usage
Syntax:
yc managed-opensearch cluster update <CLUSTER-NAME>|<CLUSTER-ID> [Flags...] [Global Flags...]
Flags
| Flag | Description |
|---|---|
--async |
Display information about the operation in progress, without waiting for the operation to complete. |
--id |
stringID of the OpenSearch cluster. |
--name |
stringName of the OpenSearch cluster. |
--max-clause-count |
intMaximum amount of clauses to use in a query. |
--fielddata-cache-size |
stringData field cache size. |
--reindex-remote-whitelist |
value[,value]Comma-separated list of host:port pairs indicating the remote sources to be reindexed. |
--snapshot-schedule |
stringSnapshot schedule type. Supported: 'hourly', 'daily', 'weekly'. Leave empty for default settings. |
--snapshot-day |
stringFor weekly schedule, the day of the week ('mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun') to start snapshot. |
--snapshot-hour |
intFor daily/weekly schedule, the hour (0-23) of the day ) to start snapshot. |
--snapshot-minute |
intFor any schedule, the minute (0-59) of the hour to start snapshot. |
--snapshot-max-age-days |
intMax snapshot age in days. 7 days minimum. |
--new-name |
stringName of the cluster. |
--description |
stringDescription of the cluster. |
--labels |
key=value[,key=value...]A list of labels given as key=value pairs. |
--security-group-names |
value[,value]A comma-separated list of security group names to be used for the cluster. |
--security-group-ids |
value[,value]A comma-separated list of security group IDs to be used for the cluster. |
--service-account-id |
stringservice account id. |
--service-account-name |
stringID of the service account to be used for the cluster. |
--delete-protection |
stringWether to inhibit or not cluster deletion. Supported values: 'true' or 'false' |
--maintenance |
PROPERTY=VALUE[,PROPERTY=VALUE...]Cluster maintenance window configuration. It defaults to anytime maintenance schedule. Possible property names:
|
--network-id |
stringNetwork id. |
--network-name |
stringNetwork name. |
--version |
stringOpenSearch version. |
--admin-password |
stringNew password for entity. It is not secure to specify password in command line. To avoid it you can omit this flag and enter password when prompted. |
--generate-admin-password |
Generate random password |
--data-transfer-access |
stringWether to allow or deny access to Data Transfer. |
--serverless-access |
stringWether to allow or deny access to Serverless. |
--plugins |
value[,value]OpenSearch plugins. |
--set-keystore-settings |
key=value[,key=value...]A comma-separated list of keystore settings to add/replace given as key=value pairs. Old entries not listed here will be left unchanged. |
--remove-keystore-settings |
value[,value]A comma-separated list of keystore settings to remove. |
Global Flags
| Flag | Description |
|---|---|
--profile |
stringSet the custom configuration file. |
--debug |
Debug logging. |
--debug-grpc |
Debug gRPC logging. Very verbose, used for debugging connection problems. |
--no-user-output |
Disable printing user intended output to stderr. |
--retry |
intEnable gRPC retries. By default, retries are enabled with maximum 5 attempts. Pass 0 to disable retries. Pass any negative value for infinite retries. Even infinite retries are capped with 2 minutes timeout. |
--cloud-id |
stringSet the ID of the cloud to use. |
--folder-id |
stringSet the ID of the folder to use. |
--folder-name |
stringSet the name of the folder to use (will be resolved to id). |
--endpoint |
stringSet the Cloud API endpoint (host:port). |
--token |
stringSet the OAuth token to use. |
--impersonate-service-account-id |
stringSet the ID of the service account to impersonate. |
--no-browser |
Disable opening browser for authentication. |
--format |
stringSet the output format: text (default), yaml, json, json-rest. |
--jq |
stringQuery to select values from the response using jq syntax |
-h,--help |
Display help for the command. |