You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticsearchService::Types::UpgradeElasticsearchDomainRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpgradeElasticsearchDomainRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain_name: "DomainName", # required
  target_version: "ElasticsearchVersionString", # required
  perform_check_only: false,
}

Container for request parameters to UpgradeElasticsearchDomain operation.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_name ⇒ String

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).

Returns:

  • (String) —

    The name of an Elasticsearch domain.

#perform_check_only ⇒ Boolean

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

Returns:

  • (Boolean) —

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed.

#target_version ⇒ String

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

Returns:

  • (String) —

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