Skip to content

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version

Description

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Usage

elasticsearchservice_upgrade_elasticsearch_domain(DomainName,
  TargetVersion, PerformCheckOnly)

Arguments

  • DomainName

    [required] The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • TargetVersion

    [required] The version of Elasticsearch that you intend to upgrade the domain to.

  • PerformCheckOnly

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

Value

A list with the following syntax:

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

Request syntax

svc$upgrade_elasticsearch_domain(
  DomainName = "string",
  TargetVersion = "string",
  PerformCheckOnly = TRUE|FALSE
)