Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.UpgradeDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpgradeDomain = UpgradeDomain' {
- advancedOptions :: Maybe (HashMap Text Text)
- performCheckOnly :: Maybe Bool
- domainName :: Text
- targetVersion :: Text
}
newUpgradeDomain :: Text -> Text -> UpgradeDomain
upgradeDomain_advancedOptions :: Lens' UpgradeDomain (Maybe (HashMap Text Text))
upgradeDomain_performCheckOnly :: Lens' UpgradeDomain (Maybe Bool)
upgradeDomain_domainName :: Lens' UpgradeDomain Text
upgradeDomain_targetVersion :: Lens' UpgradeDomain Text
data UpgradeDomainResponse = UpgradeDomainResponse' {
- advancedOptions :: Maybe (HashMap Text Text)
- changeProgressDetails :: Maybe ChangeProgressDetails
- domainName :: Maybe Text
- performCheckOnly :: Maybe Bool
- targetVersion :: Maybe Text
- upgradeId :: Maybe Text
- httpStatus :: Int
}
newUpgradeDomainResponse :: Int -> UpgradeDomainResponse
upgradeDomainResponse_advancedOptions :: Lens' UpgradeDomainResponse (Maybe (HashMap Text Text))
upgradeDomainResponse_changeProgressDetails :: Lens' UpgradeDomainResponse (Maybe ChangeProgressDetails)
upgradeDomainResponse_domainName :: Lens' UpgradeDomainResponse (Maybe Text)
upgradeDomainResponse_performCheckOnly :: Lens' UpgradeDomainResponse (Maybe Bool)
upgradeDomainResponse_targetVersion :: Lens' UpgradeDomainResponse (Maybe Text)
upgradeDomainResponse_upgradeId :: Lens' UpgradeDomainResponse (Maybe Text)
upgradeDomainResponse_httpStatus :: Lens' UpgradeDomainResponse Int

Creating a Request

data UpgradeDomain Source #

Container for the request parameters to the UpgradeDomain operation.

See: newUpgradeDomain smart constructor.

Constructors

UpgradeDomain'

Fields

advancedOptions :: Maybe (HashMap Text Text)
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.
performCheckOnly :: Maybe Bool
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
domainName :: Text
Name of the OpenSearch Service domain that you want to upgrade.
targetVersion :: Text
OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

Instances

Instances details

ToJSON UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods toJSON :: UpgradeDomain -> Value # toEncoding :: UpgradeDomain -> Encoding # toJSONList :: [UpgradeDomain] -> Value # toEncodingList :: [UpgradeDomain] -> Encoding #
ToHeaders UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods toHeaders :: UpgradeDomain -> [Header] #
ToPath UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods toPath :: UpgradeDomain -> ByteString #
ToQuery UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods toQuery :: UpgradeDomain -> QueryString #
AWSRequest UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Associated Types type AWSResponse UpgradeDomain # Methods request :: (Service -> Service) -> UpgradeDomain -> Request UpgradeDomain # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpgradeDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpgradeDomain))) #
Generic UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Associated Types type Rep UpgradeDomain :: Type -> Type # Methods from :: UpgradeDomain -> Rep UpgradeDomain x # to :: Rep UpgradeDomain x -> UpgradeDomain #
Read UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods readsPrec :: Int -> ReadS UpgradeDomain # readList :: ReadS [UpgradeDomain] # readPrec :: ReadPrec UpgradeDomain # readListPrec :: ReadPrec [UpgradeDomain] #
Show UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods showsPrec :: Int -> UpgradeDomain -> ShowS # show :: UpgradeDomain -> String # showList :: [UpgradeDomain] -> ShowS #
NFData UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods rnf :: UpgradeDomain -> () #
Eq UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods (==) :: UpgradeDomain -> UpgradeDomain -> Bool # (/=) :: UpgradeDomain -> UpgradeDomain -> Bool #
Hashable UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods hashWithSalt :: Int -> UpgradeDomain -> Int # hash :: UpgradeDomain -> Int #
type AWSResponse UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type AWSResponse UpgradeDomain = UpgradeDomainResponse
type Rep UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type Rep UpgradeDomain = D1 ('MetaData "UpgradeDomain" "Amazonka.OpenSearch.UpgradeDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "UpgradeDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "performCheckOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpgradeDomain Source #

Arguments

:: Text	`UpgradeDomain`
-> Text	`UpgradeDomain`
-> UpgradeDomain

Create a value of UpgradeDomain with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpgradeDomain, upgradeDomain_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.

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

UpgradeDomain, upgradeDomain_domainName - Name of the OpenSearch Service domain that you want to upgrade.

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

Request Lenses

upgradeDomain_advancedOptions :: Lens' UpgradeDomain (Maybe (HashMap Text Text)) Source #

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.

upgradeDomain_performCheckOnly :: Lens' UpgradeDomain (Maybe Bool) Source #

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

upgradeDomain_domainName :: Lens' UpgradeDomain Text Source #

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

upgradeDomain_targetVersion :: Lens' UpgradeDomain Text Source #

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

Destructuring the Response

data UpgradeDomainResponse Source #

Container for the response returned by UpgradeDomain operation.

See: newUpgradeDomainResponse smart constructor.

Constructors

UpgradeDomainResponse'

Fields

advancedOptions :: Maybe (HashMap Text Text)
The advanced options configuration for the domain.
changeProgressDetails :: Maybe ChangeProgressDetails
Container for information about a configuration change happening on a domain.
domainName :: Maybe Text
The name of the domain that was upgraded.
performCheckOnly :: Maybe Bool
When true, indicates that an upgrade eligibility check was performed.
targetVersion :: Maybe Text
OpenSearch or Elasticsearch version that the domain was upgraded to.
upgradeId :: Maybe Text
The unique identifier of the domain upgrade.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Associated Types type Rep UpgradeDomainResponse :: Type -> Type # Methods from :: UpgradeDomainResponse -> Rep UpgradeDomainResponse x # to :: Rep UpgradeDomainResponse x -> UpgradeDomainResponse #
Read UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods readsPrec :: Int -> ReadS UpgradeDomainResponse # readList :: ReadS [UpgradeDomainResponse] # readPrec :: ReadPrec UpgradeDomainResponse # readListPrec :: ReadPrec [UpgradeDomainResponse] #
Show UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods showsPrec :: Int -> UpgradeDomainResponse -> ShowS # show :: UpgradeDomainResponse -> String # showList :: [UpgradeDomainResponse] -> ShowS #
NFData UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods rnf :: UpgradeDomainResponse -> () #
Eq UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods (==) :: UpgradeDomainResponse -> UpgradeDomainResponse -> Bool # (/=) :: UpgradeDomainResponse -> UpgradeDomainResponse -> Bool #
type Rep UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type Rep UpgradeDomainResponse = D1 ('MetaData "UpgradeDomainResponse" "Amazonka.OpenSearch.UpgradeDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "UpgradeDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "changeProgressDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeProgressDetails)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "performCheckOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "targetVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "upgradeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpgradeDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpgradeDomainResponse'`
-> UpgradeDomainResponse

Create a value of UpgradeDomainResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpgradeDomain, upgradeDomainResponse_advancedOptions - The advanced options configuration for the domain.

UpgradeDomainResponse, upgradeDomainResponse_changeProgressDetails - Container for information about a configuration change happening on a domain.

UpgradeDomain, upgradeDomainResponse_domainName - The name of the domain that was upgraded.

UpgradeDomain, upgradeDomainResponse_performCheckOnly - When true, indicates that an upgrade eligibility check was performed.

UpgradeDomain, upgradeDomainResponse_targetVersion - OpenSearch or Elasticsearch version that the domain was upgraded to.

$sel:upgradeId:UpgradeDomainResponse', upgradeDomainResponse_upgradeId - The unique identifier of the domain upgrade.

$sel:httpStatus:UpgradeDomainResponse', upgradeDomainResponse_httpStatus - The response's http status code.

Response Lenses

upgradeDomainResponse_advancedOptions :: Lens' UpgradeDomainResponse (Maybe (HashMap Text Text)) Source #

The advanced options configuration for the domain.

upgradeDomainResponse_changeProgressDetails :: Lens' UpgradeDomainResponse (Maybe ChangeProgressDetails) Source #

Container for information about a configuration change happening on a domain.

upgradeDomainResponse_domainName :: Lens' UpgradeDomainResponse (Maybe Text) Source #

The name of the domain that was upgraded.

upgradeDomainResponse_performCheckOnly :: Lens' UpgradeDomainResponse (Maybe Bool) Source #

When true, indicates that an upgrade eligibility check was performed.

upgradeDomainResponse_targetVersion :: Lens' UpgradeDomainResponse (Maybe Text) Source #

OpenSearch or Elasticsearch version that the domain was upgraded to.

upgradeDomainResponse_upgradeId :: Lens' UpgradeDomainResponse (Maybe Text) Source #

The unique identifier of the domain upgrade.

upgradeDomainResponse_httpStatus :: Lens' UpgradeDomainResponse Int Source #

The response's http status code.