Upgrade Domain

opensearchservice_upgrade_domain

R Documentation

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch

Description

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Usage

opensearchservice_upgrade_domain(DomainName, TargetVersion,
  PerformCheckOnly, AdvancedOptions)

Arguments

DomainName

[required] Name of the OpenSearch Service domain that you want to upgrade.

TargetVersion

[required] OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

PerformCheckOnly

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

AdvancedOptions

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Value

A list with the following syntax:

list(
  UpgradeId = "string",
  DomainName = "string",
  TargetVersion = "string",
  PerformCheckOnly = TRUE|FALSE,
  AdvancedOptions = list(
    "string"
  ),
  ChangeProgressDetails = list(
    ChangeId = "string",
    Message = "string",
    ConfigChangeStatus = "Pending"|"Initializing"|"Validating"|"ValidationFailed"|"ApplyingChanges"|"Completed"|"PendingUserInput"|"Cancelled",
    InitiatedBy = "CUSTOMER"|"SERVICE",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$upgrade_domain(
  DomainName = "string",
  TargetVersion = "string",
  PerformCheckOnly = TRUE|FALSE,
  AdvancedOptions = list(
    "string"
  )
)