Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.UpgradeDomain

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

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

Creating a Request

data UpgradeDomain Source #

Container for the request parameters to UpgradeDomain operation.

See: newUpgradeDomain smart constructor.

Constructors

UpgradeDomain'
Fields performCheckOnly :: Maybe Bool When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. advancedOptions :: Maybe (HashMap Text Text) domainName :: Text targetVersion :: Text The version of OpenSearch you intend to upgrade the domain to.

Instances

Instances details

Eq UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods (==) :: UpgradeDomain -> UpgradeDomain -> Bool # (/=) :: UpgradeDomain -> UpgradeDomain -> Bool #
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 #
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 #
NFData UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods rnf :: UpgradeDomain -> () #
Hashable UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods hashWithSalt :: Int -> UpgradeDomain -> Int # hash :: UpgradeDomain -> Int #
ToJSON UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods toJSON :: UpgradeDomain -> Value # toEncoding :: UpgradeDomain -> Encoding # toJSONList :: [UpgradeDomain] -> Value # toEncodingList :: [UpgradeDomain] -> Encoding #
AWSRequest UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Associated Types type AWSResponse UpgradeDomain # Methods request :: UpgradeDomain -> Request UpgradeDomain # response :: MonadResource m => Logger -> Service -> Proxy UpgradeDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpgradeDomain))) #
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 #
type Rep UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type Rep UpgradeDomain = D1 ('MetaData "UpgradeDomain" "Amazonka.OpenSearch.UpgradeDomain" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "UpgradeDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "performCheckOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpgradeDomain Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type AWSResponse UpgradeDomain = UpgradeDomainResponse

newUpgradeDomain Source #

Arguments

:: Text	`$sel:domainName:UpgradeDomain'`
-> Text	`$sel:targetVersion: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:

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

$sel:advancedOptions:UpgradeDomain', upgradeDomain_advancedOptions - Undocumented member.

$sel:domainName:UpgradeDomain', upgradeDomain_domainName - Undocumented member.

$sel:targetVersion:UpgradeDomain', upgradeDomain_targetVersion - The version of OpenSearch you intend to upgrade the domain to.

Request Lenses

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_advancedOptions :: Lens' UpgradeDomain (Maybe (HashMap Text Text)) Source #

Undocumented member.

upgradeDomain_domainName :: Lens' UpgradeDomain Text Source #

Undocumented member.

upgradeDomain_targetVersion :: Lens' UpgradeDomain Text Source #

The version of OpenSearch you intend to upgrade the domain to.

Destructuring the Response

data UpgradeDomainResponse Source #

Container for response returned by UpgradeDomain operation.

See: newUpgradeDomainResponse smart constructor.

Constructors

UpgradeDomainResponse'
Fields domainName :: Maybe Text upgradeId :: Maybe Text performCheckOnly :: Maybe Bool When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. targetVersion :: Maybe Text The version of OpenSearch that you intend to upgrade the domain to. advancedOptions :: Maybe (HashMap Text Text) httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods (==) :: UpgradeDomainResponse -> UpgradeDomainResponse -> Bool # (/=) :: UpgradeDomainResponse -> UpgradeDomainResponse -> Bool #
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 #
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 #
NFData UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain Methods rnf :: UpgradeDomainResponse -> () #
type Rep UpgradeDomainResponse Source #
Instance details Defined in Amazonka.OpenSearch.UpgradeDomain type Rep UpgradeDomainResponse = D1 ('MetaData "UpgradeDomainResponse" "Amazonka.OpenSearch.UpgradeDomain" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "UpgradeDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "upgradeId") '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 "advancedOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text 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:

$sel:domainName:UpgradeDomain', upgradeDomainResponse_domainName - Undocumented member.

$sel:upgradeId:UpgradeDomainResponse', upgradeDomainResponse_upgradeId - Undocumented member.

$sel:performCheckOnly:UpgradeDomain', upgradeDomainResponse_performCheckOnly - When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

$sel:targetVersion:UpgradeDomain', upgradeDomainResponse_targetVersion - The version of OpenSearch that you intend to upgrade the domain to.

$sel:advancedOptions:UpgradeDomain', upgradeDomainResponse_advancedOptions - Undocumented member.

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

Response Lenses

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

Undocumented member.

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

Undocumented member.

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

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

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

The version of OpenSearch that you intend to upgrade the domain to.

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

Undocumented member.

upgradeDomainResponse_httpStatus :: Lens' UpgradeDomainResponse Int Source #

The response's http status code.