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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb

Overview

Note:

When making an API call, you may pass UpgradeElasticsearchDomainRequest data as a hash:

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

Container for request parameters to UpgradeElasticsearchDomain operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

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)


4497
4498
4499
4500
4501
4502
4503
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 4497

class UpgradeElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :target_version,
  :perform_check_only)
  SENSITIVE = []
  include Aws::Structure
end

#perform_check_onlyBoolean

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)


4497
4498
4499
4500
4501
4502
4503
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 4497

class UpgradeElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :target_version,
  :perform_check_only)
  SENSITIVE = []
  include Aws::Structure
end

#target_versionString

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

Returns:

  • (String)


4497
4498
4499
4500
4501
4502
4503
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 4497

class UpgradeElasticsearchDomainRequest < Struct.new(
  :domain_name,
  :target_version,
  :perform_check_only)
  SENSITIVE = []
  include Aws::Structure
end