Skip to content

UpgradeDomainRequest

Source code in docs_src/capo_opensearch/types/upgrade_domain_request.py 
16
17
18
19
20
21
22
23
24
25
26
class UpgradeDomainRequest(TypedDict, closed=True):
    domain_name: "capo_opensearch.types.domain_name.DomainName"
    """<p>Name of the OpenSearch Service domain that you want to upgrade.</p>"""
    target_version: "capo_opensearch.types.version_string.VersionString"
    """<p>OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.</p>"""
    perform_check_only: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.</p>"""
    advanced_options: NotRequired[
        "capo_opensearch.types.advanced_options.AdvancedOptions"
    ]
    """<p>Only supports the <code>override_main_response_version</code> 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.</p>"""

advanced_options instance-attribute 

advanced_options: NotRequired[AdvancedOptions]

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.

domain_name instance-attribute 

domain_name: DomainName

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

perform_check_only instance-attribute 

perform_check_only: NotRequired[Boolean]

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

target_version instance-attribute 

target_version: VersionString

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