You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EKS::Types::UpdateNodegroupVersionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateNodegroupVersionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  cluster_name: "String", # required
  nodegroup_name: "String", # required
  version: "String",
  release_version: "String",
  launch_template: {
    name: "String",
    version: "String",
    id: "String",
  },
  force: false,
  client_request_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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

Returns:

  • (String) —

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

#cluster_name ⇒ String

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

Returns:

  • (String) —

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

#force ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Force the update if the existing node group\'s pods are unable to be drained due to a pod disruption budget issue.

#launch_template ⇒ Types::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.

Returns:

#nodegroup_name ⇒ String

The name of the managed node group to update.

Returns:

  • (String) —

    The name of the managed node group to update.

#release_version ⇒ String

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 more information, see Amazon EKS-Optimized Linux 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.

Returns:

  • (String) —

    The AMI version of the Amazon EKS-optimized AMI to use for the update.

#version ⇒ String

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.

Returns:

  • (String) —

    The Kubernetes version to update to.