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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.

If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

You cannot roll back a node group to an earlier Kubernetes version or AMI version.

When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.

Synopsis

Creating a Request

data UpdateNodegroupVersion Source #

See: newUpdateNodegroupVersion smart constructor.

Constructors

UpdateNodegroupVersion'

Fields

clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
force :: Maybe Bool
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
launchTemplate :: Maybe LaunchTemplateSpecification
An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.
releaseVersion :: Maybe Text
The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
version :: Maybe Text
The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
clusterName :: Text
The name of the Amazon EKS cluster that is associated with the managed node group to update.
nodegroupName :: Text
The name of the managed node group to update.

Instances

Instances details

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

newUpdateNodegroupVersion Source #

Arguments

:: Text	`UpdateNodegroupVersion`
-> Text	`UpdateNodegroupVersion`
-> UpdateNodegroupVersion

Create a value of UpdateNodegroupVersion 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:

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

$sel:force:UpdateNodegroupVersion', updateNodegroupVersion_force - Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

UpdateNodegroupVersion, updateNodegroupVersion_launchTemplate - An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.

UpdateNodegroupVersion, updateNodegroupVersion_releaseVersion - The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

UpdateNodegroupVersion, updateNodegroupVersion_version - The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

UpdateNodegroupVersion, updateNodegroupVersion_clusterName - The name of the Amazon EKS cluster that is associated with the managed node group to update.

UpdateNodegroupVersion, updateNodegroupVersion_nodegroupName - The name of the managed node group to update.

Request Lenses

updateNodegroupVersion_clientRequestToken :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

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

updateNodegroupVersion_force :: Lens' UpdateNodegroupVersion (Maybe Bool) Source #

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

updateNodegroupVersion_launchTemplate :: Lens' UpdateNodegroupVersion (Maybe LaunchTemplateSpecification) Source #

An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.

updateNodegroupVersion_releaseVersion :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

updateNodegroupVersion_version :: Lens' UpdateNodegroupVersion (Maybe Text) Source #

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

updateNodegroupVersion_clusterName :: Lens' UpdateNodegroupVersion Text Source #

The name of the Amazon EKS cluster that is associated with the managed node group to update.

updateNodegroupVersion_nodegroupName :: Lens' UpdateNodegroupVersion Text Source #

The name of the managed node group to update.

Destructuring the Response

data UpdateNodegroupVersionResponse Source #

See: newUpdateNodegroupVersionResponse smart constructor.

Constructors

UpdateNodegroupVersionResponse'
Fields update :: Maybe Update httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateNodegroupVersionResponse Source #

Arguments

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

Create a value of UpdateNodegroupVersionResponse 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:UpdateNodegroupVersionResponse', updateNodegroupVersionResponse_update - Undocumented member.

$sel:httpStatus:UpdateNodegroupVersionResponse', updateNodegroupVersionResponse_httpStatus - The response's http status code.

Response Lenses

updateNodegroupVersionResponse_update :: Lens' UpdateNodegroupVersionResponse (Maybe Update) Source #

Undocumented member.

updateNodegroupVersionResponse_httpStatus :: Lens' UpdateNodegroupVersionResponse Int Source #

The response's http status code.