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.EKS.UpdateClusterVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.

Creating a Request

data UpdateClusterVersion Source #

See: newUpdateClusterVersion smart constructor.

Constructors

UpdateClusterVersion'
Fields clientRequestToken :: Maybe Text Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. name :: Text The name of the Amazon EKS cluster to update. version :: Text The desired Kubernetes version following a successful update.

Instances

Instances details

Eq UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods (==) :: UpdateClusterVersion -> UpdateClusterVersion -> Bool # (/=) :: UpdateClusterVersion -> UpdateClusterVersion -> Bool #
Read UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods readsPrec :: Int -> ReadS UpdateClusterVersion # readList :: ReadS [UpdateClusterVersion] # readPrec :: ReadPrec UpdateClusterVersion # readListPrec :: ReadPrec [UpdateClusterVersion] #
Show UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods showsPrec :: Int -> UpdateClusterVersion -> ShowS # show :: UpdateClusterVersion -> String # showList :: [UpdateClusterVersion] -> ShowS #
Generic UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Associated Types type Rep UpdateClusterVersion :: Type -> Type # Methods from :: UpdateClusterVersion -> Rep UpdateClusterVersion x # to :: Rep UpdateClusterVersion x -> UpdateClusterVersion #
NFData UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods rnf :: UpdateClusterVersion -> () #
Hashable UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods hashWithSalt :: Int -> UpdateClusterVersion -> Int # hash :: UpdateClusterVersion -> Int #
ToJSON UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods toJSON :: UpdateClusterVersion -> Value # toEncoding :: UpdateClusterVersion -> Encoding # toJSONList :: [UpdateClusterVersion] -> Value # toEncodingList :: [UpdateClusterVersion] -> Encoding #
AWSRequest UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Associated Types type AWSResponse UpdateClusterVersion # Methods request :: UpdateClusterVersion -> Request UpdateClusterVersion # response :: MonadResource m => Logger -> Service -> Proxy UpdateClusterVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateClusterVersion))) #
ToHeaders UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods toHeaders :: UpdateClusterVersion -> [Header] #
ToPath UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods toPath :: UpdateClusterVersion -> ByteString #
ToQuery UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods toQuery :: UpdateClusterVersion -> QueryString #
type Rep UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion type Rep UpdateClusterVersion = D1 ('MetaData "UpdateClusterVersion" "Amazonka.EKS.UpdateClusterVersion" "libZSservicesZSamazonka-eksZSamazonka-eks" 'False) (C1 ('MetaCons "UpdateClusterVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateClusterVersion Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion type AWSResponse UpdateClusterVersion = UpdateClusterVersionResponse

newUpdateClusterVersion Source #

Arguments

:: Text	`$sel:name:UpdateClusterVersion'`
-> Text	`$sel:version:UpdateClusterVersion'`
-> UpdateClusterVersion

Create a value of UpdateClusterVersion 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:clientRequestToken:UpdateClusterVersion', updateClusterVersion_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:name:UpdateClusterVersion', updateClusterVersion_name - The name of the Amazon EKS cluster to update.

$sel:version:UpdateClusterVersion', updateClusterVersion_version - The desired Kubernetes version following a successful update.

Request Lenses

updateClusterVersion_clientRequestToken :: Lens' UpdateClusterVersion (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

updateClusterVersion_name :: Lens' UpdateClusterVersion Text Source #

The name of the Amazon EKS cluster to update.

updateClusterVersion_version :: Lens' UpdateClusterVersion Text Source #

The desired Kubernetes version following a successful update.

Destructuring the Response

data UpdateClusterVersionResponse Source #

See: newUpdateClusterVersionResponse smart constructor.

Constructors

UpdateClusterVersionResponse'
Fields update :: Maybe Update The full description of the specified update httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods (==) :: UpdateClusterVersionResponse -> UpdateClusterVersionResponse -> Bool # (/=) :: UpdateClusterVersionResponse -> UpdateClusterVersionResponse -> Bool #
Read UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods readsPrec :: Int -> ReadS UpdateClusterVersionResponse # readList :: ReadS [UpdateClusterVersionResponse] # readPrec :: ReadPrec UpdateClusterVersionResponse # readListPrec :: ReadPrec [UpdateClusterVersionResponse] #
Show UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods showsPrec :: Int -> UpdateClusterVersionResponse -> ShowS # show :: UpdateClusterVersionResponse -> String # showList :: [UpdateClusterVersionResponse] -> ShowS #
Generic UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Associated Types type Rep UpdateClusterVersionResponse :: Type -> Type # Methods from :: UpdateClusterVersionResponse -> Rep UpdateClusterVersionResponse x # to :: Rep UpdateClusterVersionResponse x -> UpdateClusterVersionResponse #
NFData UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion Methods rnf :: UpdateClusterVersionResponse -> () #
type Rep UpdateClusterVersionResponse Source #
Instance details Defined in Amazonka.EKS.UpdateClusterVersion type Rep UpdateClusterVersionResponse = D1 ('MetaData "UpdateClusterVersionResponse" "Amazonka.EKS.UpdateClusterVersion" "libZSservicesZSamazonka-eksZSamazonka-eks" 'False) (C1 ('MetaCons "UpdateClusterVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Update)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClusterVersionResponse Source #

Arguments

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

Create a value of UpdateClusterVersionResponse 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:update:UpdateClusterVersionResponse', updateClusterVersionResponse_update - The full description of the specified update

$sel:httpStatus:UpdateClusterVersionResponse', updateClusterVersionResponse_httpStatus - The response's http status code.

Response Lenses

updateClusterVersionResponse_update :: Lens' UpdateClusterVersionResponse (Maybe Update) Source #

The full description of the specified update

updateClusterVersionResponse_httpStatus :: Lens' UpdateClusterVersionResponse Int Source #

The response's http status code.