class Aws::OpenSearchService::Types::UpgradeDomainRequest
Container for the request parameters to ` UpgradeDomain ` operation.
@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", }, }
@!attribute [rw] domain_name
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). @return [String]
@!attribute [rw] target_version
The version of OpenSearch you intend to upgrade the domain to. @return [String]
@!attribute [rw] perform_check_only
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. @return [Boolean]
@!attribute [rw] advanced_options
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 ][1] 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][1]. [1]: http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomainRequest AWS API Documentation
Constants
- SENSITIVE