Class: Aws::OpenSearchService::Types::UpgradeDomainRequest

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

Overview

Note:

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

{
  domain_name: "DomainName", # required
  target_version: "VersionString", # required
  perform_check_only: false,
  advanced_options: {
    "String" => "String",
  },
}

Container for the request parameters to UpgradeDomain operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_optionsHash<String,String>

Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
  • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

For more information, see Advanced cluster parameters.

Returns:

  • (Hash<String,String>)


4796
4797
4798
4799
4800
4801
4802
4803
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4796

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

#domain_nameString

The name of an 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)


4796
4797
4798
4799
4800
4801
4802
4803
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4796

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

#perform_check_onlyBoolean

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

Returns:

  • (Boolean)


4796
4797
4798
4799
4800
4801
4802
4803
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4796

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

#target_versionString

The version of OpenSearch you intend to upgrade the domain to.

Returns:

  • (String)


4796
4797
4798
4799
4800
4801
4802
4803
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4796

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