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

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

Overview

Container for the request parameters to the UpgradeDomain operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_options ⇒ Hash<String,String>

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Returns:

  • (Hash<String,String>)


10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 10588

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

#deployment_strategy_options ⇒ Types::DeploymentStrategyOverrideOptions

Overrides the deployment strategy for this upgrade. To run a cloned blue/green upgrade, set DeploymentStrategy to ClonedBlueGreen.



10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 10588

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

#domain_name ⇒ String

Name of the OpenSearch Service domain that you want to upgrade.

Returns:

  • (String)


10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 10588

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

#perform_check_only ⇒ Boolean

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

Returns:

  • (Boolean)


10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 10588

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

#target_version ⇒ String

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

Returns:

  • (String)


10588
10589
10590
10591
10592
10593
10594
10595
10596
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 10588

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