upgradeDomain method

Future<UpgradeDomainResponse> upgradeDomain({ required String domainName, required String targetVersion, Map<String, String>? advancedOptions, bool? performCheckOnly, })

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

May throw BaseException. May throw DisabledOperationException. May throw InternalException. May throw ResourceAlreadyExistsException. May throw ResourceNotFoundException. May throw ValidationException.

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

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

Parameter 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.

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

Implementation

Future<UpgradeDomainResponse> upgradeDomain({
  required String domainName,
  required String targetVersion,
  Map<String, String>? advancedOptions,
  bool? performCheckOnly,
}) async {
  final $payload = <String, dynamic>{
    'DomainName': domainName,
    'TargetVersion': targetVersion,
    if (advancedOptions != null) 'AdvancedOptions': advancedOptions,
    if (performCheckOnly != null) 'PerformCheckOnly': performCheckOnly,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/2021-01-01/opensearch/upgradeDomain',
    exceptionFnMap: _exceptionFns,
  );
  return UpgradeDomainResponse.fromJson(response);
}