Table of Contents
A low-level client representing Amazon Elastic Kubernetes Service (EKS)
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
import boto3
client = boto3.client('eks')
These are the available methods:
Check if an operation can be paginated.
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with platform version eks.3 or later because add-ons rely on the Server-side Apply Kubernetes feature, which is only available in Kubernetes 1.18 and later.
See also: AWS API Documentation
Request Syntax
response = client.create_addon(
clusterName='string',
addonName='string',
addonVersion='string',
serviceAccountRoleArn='string',
resolveConflicts='OVERWRITE'|'NONE',
clientRequestToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the cluster to create the add-on for.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide .
Note
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide .
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.
dict
Response Syntax
{
'addon': {
'addonName': 'string',
'clusterName': 'string',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED',
'addonVersion': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'addonArn': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'serviceAccountRoleArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
addon (dict) --
An Amazon EKS add-on.
addonName (string) --
The name of the add-on.
clusterName (string) --
The name of the cluster.
status (string) --
The status of the add-on.
addonVersion (string) --
The version of the add-on.
health (dict) --
An object that represents the health of the add-on.
issues (list) --
An object that represents the add-on's health issues.
(dict) --
An issue related to an add-on.
code (string) --
A code that describes the type of issue.
message (string) --
A message that provides details about the issue and what might cause it.
resourceIds (list) --
The resource IDs of the issue.
addonArn (string) --
The Amazon Resource Name (ARN) of the add-on.
createdAt (datetime) --
The date and time that the add-on was created.
modifiedAt (datetime) --
The date and time that the add-on was last modified.
serviceAccountRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
Exceptions
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec , logs , and proxy data flows).
Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the * Amazon EKS User Guide * .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing .
Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
name='string',
version='string',
roleArn='string',
resourcesVpcConfig={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
kubernetesNetworkConfig={
'serviceIpv4Cidr': 'string'
},
logging={
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
clientRequestToken='string',
tags={
'string': 'string'
},
encryptionConfig=[
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
]
)
[REQUIRED]
The unique name to give to your cluster.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the * Amazon EKS User Guide * .
[REQUIRED]
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:
For more information, see Amazon EKS security group considerations in the * Amazon EKS User Guide * .
Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true , which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false , which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The Kubernetes network configuration for the cluster.
The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:
Warning
You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the * Amazon EKS User Guide * .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing .
The cluster control plane logging configuration for your cluster.
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
The available cluster control plane log types.
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.
The encryption configuration for the cluster.
The encryption configuration for the cluster.
Specifies the resources to be encrypted. The only supported value is "secrets".
AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.
Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide .
dict
Response Syntax
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string'
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'certificateAuthority': {
'data': 'string'
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
]
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your new cluster.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
resourcesVpcConfig (dict) --
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide .
subnetIds (list) --
The subnets associated with your cluster.
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.
clusterSecurityGroupId (string) --
The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
vpcId (string) --
The VPC associated with your cluster.
endpointPublicAccess (boolean) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.
logging (dict) --
The logging configuration for your cluster.
clusterLogging (list) --
The cluster control plane logging configuration for your cluster.
(dict) --
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
types (list) --
The available cluster control plane log types.
enabled (boolean) --
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
identity (dict) --
The identity provider information for the cluster.
oidc (dict) --
The OpenID Connect identity provider information for the cluster.
issuer (string) --
The issuer URL for the OpenID Connect identity provider.
status (string) --
The current status of the cluster.
certificateAuthority (dict) --
The certificate-authority-data for your cluster.
data (string) --
The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
encryptionConfig (list) --
The encryption configuration for the cluster.
(dict) --
The encryption configuration for the cluster.
resources (list) --
Specifies the resources to be encrypted. The only supported value is "secrets".
provider (dict) --
AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide .
Exceptions
Examples
The following example creates an Amazon EKS cluster called prod.
response = client.create_cluster(
version='1.10',
name='prod',
clientRequestToken='1d2129a1-3d38-460a-9756-e5b91fddb951',
resourcesVpcConfig={
'securityGroupIds': [
'sg-6979fe18',
],
'subnetIds': [
'subnet-6782e71e',
'subnet-e7e761ac',
],
},
roleArn='arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide .
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_fargate_profile(
fargateProfileName='string',
clusterName='string',
podExecutionRoleArn='string',
subnets=[
'string',
],
selectors=[
{
'namespace': 'string',
'labels': {
'string': 'string'
}
},
],
clientRequestToken='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the Fargate profile.
[REQUIRED]
The name of the Amazon EKS cluster to apply the Fargate profile to.
[REQUIRED]
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide .
The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.
The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.
An object representing an AWS Fargate profile selector.
The Kubernetes namespace that the selector should match.
The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
dict
Response Syntax
{
'fargateProfile': {
'fargateProfileName': 'string',
'fargateProfileArn': 'string',
'clusterName': 'string',
'createdAt': datetime(2015, 1, 1),
'podExecutionRoleArn': 'string',
'subnets': [
'string',
],
'selectors': [
{
'namespace': 'string',
'labels': {
'string': 'string'
}
},
],
'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
fargateProfile (dict) --
The full description of your new Fargate profile.
fargateProfileName (string) --
The name of the Fargate profile.
fargateProfileArn (string) --
The full Amazon Resource Name (ARN) of the Fargate profile.
clusterName (string) --
The name of the Amazon EKS cluster that the Fargate profile belongs to.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the Fargate profile was created.
podExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide .
subnets (list) --
The IDs of subnets to launch pods into.
selectors (list) --
The selectors to match for pods to use this Fargate profile.
(dict) --
An object representing an AWS Fargate profile selector.
namespace (string) --
The Kubernetes namespace that the selector should match.
labels (dict) --
The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
status (string) --
The current status of the Fargate profile.
tags (dict) --
The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
Exceptions
Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support .
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_nodegroup(
clusterName='string',
nodegroupName='string',
scalingConfig={
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
diskSize=123,
subnets=[
'string',
],
instanceTypes=[
'string',
],
amiType='AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64',
remoteAccess={
'ec2SshKey': 'string',
'sourceSecurityGroups': [
'string',
]
},
nodeRole='string',
labels={
'string': 'string'
},
tags={
'string': 'string'
},
clientRequestToken='string',
launchTemplate={
'name': 'string',
'version': 'string',
'id': 'string'
},
capacityType='ON_DEMAND'|'SPOT',
version='string',
releaseVersion='string'
)
[REQUIRED]
The name of the cluster to create the node group in.
[REQUIRED]
The unique name to give your node group.
The scaling configuration details for the Auto Scaling group that is created for your node group.
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
The current number of worker nodes that the managed node group should maintain.
[REQUIRED]
The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared , where CLUSTER_NAME is replaced with the name of your cluster. If you specify launchTemplate , then don't specify ` SubnetId https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html`__ in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate , then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes . If however, you specify an instance type in your launch template and specify any instanceTypes , the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes , then t3.medium is used, by default. If you specify Spot for capacityType , then we recommend specifying multiple values for instanceTypes . For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide .
The remote access (SSH) configuration to use with your node group. If you specify launchTemplate , then don't specify remoteAccess , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .
The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the * Amazon EKS User Guide * . If you specify launchTemplate , then don't specify ` IamInstanceProfile https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html`__ in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The Kubernetes labels to be applied to the nodes in the node group when they are created.
The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
An object representing a node group's launch template specification. If specified, then do not specify instanceTypes , diskSize , or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification .
The name of the launch template.
The version of the launch template to use. If no version is specified, then the template's default version is used.
The ID of the launch template.
dict
Response Syntax
{
'nodegroup': {
'nodegroupName': 'string',
'nodegroupArn': 'string',
'clusterName': 'string',
'version': 'string',
'releaseVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED',
'capacityType': 'ON_DEMAND'|'SPOT',
'scalingConfig': {
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
'instanceTypes': [
'string',
],
'subnets': [
'string',
],
'remoteAccess': {
'ec2SshKey': 'string',
'sourceSecurityGroups': [
'string',
]
},
'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64',
'nodeRole': 'string',
'labels': {
'string': 'string'
},
'resources': {
'autoScalingGroups': [
{
'name': 'string'
},
],
'remoteAccessSecurityGroup': 'string'
},
'diskSize': 123,
'health': {
'issues': [
{
'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'launchTemplate': {
'name': 'string',
'version': 'string',
'id': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
nodegroup (dict) --
The full description of your new node group.
nodegroupName (string) --
The name associated with an Amazon EKS managed node group.
nodegroupArn (string) --
The Amazon Resource Name (ARN) associated with the managed node group.
clusterName (string) --
The name of the cluster that the managed node group resides in.
version (string) --
The Kubernetes version of the managed node group.
releaseVersion (string) --
If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was created.
modifiedAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was last modified.
status (string) --
The current status of the managed node group.
capacityType (string) --
The capacity type of your managed node group.
scalingConfig (dict) --
The scaling configuration details for the Auto Scaling group that is associated with your node group.
minSize (integer) --
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
maxSize (integer) --
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
desiredSize (integer) --
The current number of worker nodes that the managed node group should maintain.
instanceTypes (list) --
If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null .
subnets (list) --
The subnets that were specified for the Auto Scaling group that is associated with your node group.
remoteAccess (dict) --
If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null .
ec2SshKey (string) --
The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .
sourceSecurityGroups (list) --
The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
amiType (string) --
If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM . For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.
nodeRole (string) --
The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.
labels (dict) --
The Kubernetes labels applied to the nodes in the node group.
Note
Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
resources (dict) --
The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
autoScalingGroups (list) --
The Auto Scaling groups associated with the node group.
(dict) --
An Auto Scaling group that is associated with an Amazon EKS managed node group.
name (string) --
The name of the Auto Scaling group associated with an Amazon EKS managed node group.
remoteAccessSecurityGroup (string) --
The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.
diskSize (integer) --
If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null .
health (dict) --
The health status of the node group. If there are issues with your node group's health, they are listed here.
issues (list) --
Any issues that are associated with the node group.
(dict) --
An object representing an issue with an Amazon EKS resource.
code (string) --
A brief description of the error.
message (string) --
The error message associated with the issue.
resourceIds (list) --
The AWS resources that are afflicted by this issue.
launchTemplate (dict) --
If a launch template was used to create the node group, then this is the launch template that was used.
name (string) --
The name of the launch template.
version (string) --
The version of the launch template to use. If no version is specified, then the template's default version is used.
id (string) --
The ID of the launch template.
tags (dict) --
The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Exceptions
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.
See also: AWS API Documentation
Request Syntax
response = client.delete_addon(
clusterName='string',
addonName='string'
)
[REQUIRED]
The name of the cluster to delete the add-on from.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
dict
Response Syntax
{
'addon': {
'addonName': 'string',
'clusterName': 'string',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED',
'addonVersion': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'addonArn': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'serviceAccountRoleArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
addon (dict) --
An Amazon EKS add-on.
addonName (string) --
The name of the add-on.
clusterName (string) --
The name of the cluster.
status (string) --
The status of the add-on.
addonVersion (string) --
The version of the add-on.
health (dict) --
An object that represents the health of the add-on.
issues (list) --
An object that represents the add-on's health issues.
(dict) --
An issue related to an add-on.
code (string) --
A code that describes the type of issue.
message (string) --
A message that provides details about the issue and what might cause it.
resourceIds (list) --
The resource IDs of the issue.
addonArn (string) --
The Amazon Resource Name (ARN) of the add-on.
createdAt (datetime) --
The date and time that the add-on was created.
modifiedAt (datetime) --
The date and time that the add-on was last modified.
serviceAccountRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
Exceptions
Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide .
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile .
See also: AWS API Documentation
Request Syntax
response = client.delete_cluster(
name='string'
)
[REQUIRED]
The name of the cluster to delete.
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string'
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'certificateAuthority': {
'data': 'string'
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
]
}
}
Response Structure
The full description of the cluster to delete.
The name of the cluster.
The Amazon Resource Name (ARN) of the cluster.
The Unix epoch timestamp in seconds for when the cluster was created.
The Kubernetes server version for the cluster.
The endpoint for your Kubernetes API server.
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide .
The subnets associated with your cluster.
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.
The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
The VPC associated with your cluster.
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The Kubernetes network configuration for the cluster.
The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.
The logging configuration for your cluster.
The cluster control plane logging configuration for your cluster.
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
The available cluster control plane log types.
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
The identity provider information for the cluster.
The OpenID Connect identity provider information for the cluster.
The issuer URL for the OpenID Connect identity provider.
The current status of the cluster.
The certificate-authority-data for your cluster.
The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
The encryption configuration for the cluster.
The encryption configuration for the cluster.
Specifies the resources to be encrypted. The only supported value is "secrets".
AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.
Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide .
Exceptions
Examples
This example command deletes a cluster named devel in your default region.
response = client.delete_cluster(
name='devel',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.
See also: AWS API Documentation
Request Syntax
response = client.delete_fargate_profile(
clusterName='string',
fargateProfileName='string'
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the Fargate profile to delete.
[REQUIRED]
The name of the Fargate profile to delete.
dict
Response Syntax
{
'fargateProfile': {
'fargateProfileName': 'string',
'fargateProfileArn': 'string',
'clusterName': 'string',
'createdAt': datetime(2015, 1, 1),
'podExecutionRoleArn': 'string',
'subnets': [
'string',
],
'selectors': [
{
'namespace': 'string',
'labels': {
'string': 'string'
}
},
],
'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
fargateProfile (dict) --
The deleted Fargate profile.
fargateProfileName (string) --
The name of the Fargate profile.
fargateProfileArn (string) --
The full Amazon Resource Name (ARN) of the Fargate profile.
clusterName (string) --
The name of the Amazon EKS cluster that the Fargate profile belongs to.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the Fargate profile was created.
podExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide .
subnets (list) --
The IDs of subnets to launch pods into.
selectors (list) --
The selectors to match for pods to use this Fargate profile.
(dict) --
An object representing an AWS Fargate profile selector.
namespace (string) --
The Kubernetes namespace that the selector should match.
labels (dict) --
The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
status (string) --
The current status of the Fargate profile.
tags (dict) --
The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
Exceptions
Deletes an Amazon EKS node group for a cluster.
See also: AWS API Documentation
Request Syntax
response = client.delete_nodegroup(
clusterName='string',
nodegroupName='string'
)
[REQUIRED]
The name of the Amazon EKS cluster that is associated with your node group.
[REQUIRED]
The name of the node group to delete.
dict
Response Syntax
{
'nodegroup': {
'nodegroupName': 'string',
'nodegroupArn': 'string',
'clusterName': 'string',
'version': 'string',
'releaseVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED',
'capacityType': 'ON_DEMAND'|'SPOT',
'scalingConfig': {
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
'instanceTypes': [
'string',
],
'subnets': [
'string',
],
'remoteAccess': {
'ec2SshKey': 'string',
'sourceSecurityGroups': [
'string',
]
},
'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64',
'nodeRole': 'string',
'labels': {
'string': 'string'
},
'resources': {
'autoScalingGroups': [
{
'name': 'string'
},
],
'remoteAccessSecurityGroup': 'string'
},
'diskSize': 123,
'health': {
'issues': [
{
'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'launchTemplate': {
'name': 'string',
'version': 'string',
'id': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
nodegroup (dict) --
The full description of your deleted node group.
nodegroupName (string) --
The name associated with an Amazon EKS managed node group.
nodegroupArn (string) --
The Amazon Resource Name (ARN) associated with the managed node group.
clusterName (string) --
The name of the cluster that the managed node group resides in.
version (string) --
The Kubernetes version of the managed node group.
releaseVersion (string) --
If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was created.
modifiedAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was last modified.
status (string) --
The current status of the managed node group.
capacityType (string) --
The capacity type of your managed node group.
scalingConfig (dict) --
The scaling configuration details for the Auto Scaling group that is associated with your node group.
minSize (integer) --
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
maxSize (integer) --
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
desiredSize (integer) --
The current number of worker nodes that the managed node group should maintain.
instanceTypes (list) --
If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null .
subnets (list) --
The subnets that were specified for the Auto Scaling group that is associated with your node group.
remoteAccess (dict) --
If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null .
ec2SshKey (string) --
The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .
sourceSecurityGroups (list) --
The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
amiType (string) --
If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM . For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.
nodeRole (string) --
The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.
labels (dict) --
The Kubernetes labels applied to the nodes in the node group.
Note
Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
resources (dict) --
The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
autoScalingGroups (list) --
The Auto Scaling groups associated with the node group.
(dict) --
An Auto Scaling group that is associated with an Amazon EKS managed node group.
name (string) --
The name of the Auto Scaling group associated with an Amazon EKS managed node group.
remoteAccessSecurityGroup (string) --
The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.
diskSize (integer) --
If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null .
health (dict) --
The health status of the node group. If there are issues with your node group's health, they are listed here.
issues (list) --
Any issues that are associated with the node group.
(dict) --
An object representing an issue with an Amazon EKS resource.
code (string) --
A brief description of the error.
message (string) --
The error message associated with the issue.
resourceIds (list) --
The AWS resources that are afflicted by this issue.
launchTemplate (dict) --
If a launch template was used to create the node group, then this is the launch template that was used.
name (string) --
The name of the launch template.
version (string) --
The version of the launch template to use. If no version is specified, then the template's default version is used.
id (string) --
The ID of the launch template.
tags (dict) --
The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Exceptions
Describes an Amazon EKS add-on.
See also: AWS API Documentation
Request Syntax
response = client.describe_addon(
clusterName='string',
addonName='string'
)
[REQUIRED]
The name of the cluster.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
dict
Response Syntax
{
'addon': {
'addonName': 'string',
'clusterName': 'string',
'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETE_FAILED'|'DEGRADED',
'addonVersion': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'InternalFailure'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'addonArn': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'serviceAccountRoleArn': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
addon (dict) --
An Amazon EKS add-on.
addonName (string) --
The name of the add-on.
clusterName (string) --
The name of the cluster.
status (string) --
The status of the add-on.
addonVersion (string) --
The version of the add-on.
health (dict) --
An object that represents the health of the add-on.
issues (list) --
An object that represents the add-on's health issues.
(dict) --
An issue related to an add-on.
code (string) --
A code that describes the type of issue.
message (string) --
A message that provides details about the issue and what might cause it.
resourceIds (list) --
The resource IDs of the issue.
addonArn (string) --
The Amazon Resource Name (ARN) of the add-on.
createdAt (datetime) --
The date and time that the add-on was created.
modifiedAt (datetime) --
The date and time that the add-on was last modified.
serviceAccountRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
Exceptions
Describes the Kubernetes versions that the add-on can be used with.
See also: AWS API Documentation
Request Syntax
response = client.describe_addon_versions(
kubernetesVersion='string',
maxResults=123,
nextToken='string',
addonName='string'
)
The nextToken value returned from a previous paginated DescribeAddonVersionsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'addons': [
{
'addonName': 'string',
'type': 'string',
'addonVersions': [
{
'addonVersion': 'string',
'architecture': [
'string',
],
'compatibilities': [
{
'clusterVersion': 'string',
'platformVersions': [
'string',
],
'defaultVersion': True|False
},
]
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
addons (list) --
The list of available versions with Kubernetes version compatibility.
(dict) --
Information about an add-on.
addonName (string) --
The name of the add-on.
type (string) --
The type of the add-on.
addonVersions (list) --
An object that represents information about available add-on versions and compatible Kubernetes versions.
(dict) --
Information about an add-on version.
addonVersion (string) --
The version of the add-on.
architecture (list) --
The architectures that the version supports.
compatibilities (list) --
An object that represents the compatibilities of a version.
(dict) --
Compatibility information.
clusterVersion (string) --
The supported Kubernetes version of the cluster.
platformVersions (list) --
The supported compute platform.
defaultVersion (boolean) --
The supported default version.
nextToken (string) --
The nextToken value returned from a previous paginated DescribeAddonVersionsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Exceptions
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS .
Note
The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.
See also: AWS API Documentation
Request Syntax
response = client.describe_cluster(
name='string'
)
[REQUIRED]
The name of the cluster to describe.
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string'
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
'certificateAuthority': {
'data': 'string'
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
]
}
}
Response Structure
The full description of your specified cluster.
The name of the cluster.
The Amazon Resource Name (ARN) of the cluster.
The Unix epoch timestamp in seconds for when the cluster was created.
The Kubernetes server version for the cluster.
The endpoint for your Kubernetes API server.
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide .
The subnets associated with your cluster.
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.
The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
The VPC associated with your cluster.
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The Kubernetes network configuration for the cluster.
The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.
The logging configuration for your cluster.
The cluster control plane logging configuration for your cluster.
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
The available cluster control plane log types.
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
The identity provider information for the cluster.
The OpenID Connect identity provider information for the cluster.
The issuer URL for the OpenID Connect identity provider.
The current status of the cluster.
The certificate-authority-data for your cluster.
The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the * Amazon EKS User Guide * .
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
The encryption configuration for the cluster.
The encryption configuration for the cluster.
Specifies the resources to be encrypted. The only supported value is "secrets".
AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.
Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide .
Exceptions
Examples
This example command provides a description of the specified cluster in your default region.
response = client.describe_cluster(
name='devel',
)
print(response)
Expected Output:
{
'cluster': {
'version': '1.10',
'name': 'devel',
'arn': 'arn:aws:eks:us-west-2:012345678910:cluster/devel',
'certificateAuthority': {
'data': 'LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=',
},
'createdAt': 1527807879.988,
'endpoint': 'https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com',
'resourcesVpcConfig': {
'securityGroupIds': [
'sg-6979fe18',
],
'subnetIds': [
'subnet-6782e71e',
'subnet-e7e761ac',
],
'vpcId': 'vpc-950809ec',
},
'roleArn': 'arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI',
'status': 'ACTIVE',
},
'ResponseMetadata': {
'...': '...',
},
}
Returns descriptive information about an AWS Fargate profile.
See also: AWS API Documentation
Request Syntax
response = client.describe_fargate_profile(
clusterName='string',
fargateProfileName='string'
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the Fargate profile.
[REQUIRED]
The name of the Fargate profile to describe.
dict
Response Syntax
{
'fargateProfile': {
'fargateProfileName': 'string',
'fargateProfileArn': 'string',
'clusterName': 'string',
'createdAt': datetime(2015, 1, 1),
'podExecutionRoleArn': 'string',
'subnets': [
'string',
],
'selectors': [
{
'namespace': 'string',
'labels': {
'string': 'string'
}
},
],
'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
fargateProfile (dict) --
The full description of your Fargate profile.
fargateProfileName (string) --
The name of the Fargate profile.
fargateProfileArn (string) --
The full Amazon Resource Name (ARN) of the Fargate profile.
clusterName (string) --
The name of the Amazon EKS cluster that the Fargate profile belongs to.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the Fargate profile was created.
podExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide .
subnets (list) --
The IDs of subnets to launch pods into.
selectors (list) --
The selectors to match for pods to use this Fargate profile.
(dict) --
An object representing an AWS Fargate profile selector.
namespace (string) --
The Kubernetes namespace that the selector should match.
labels (dict) --
The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
status (string) --
The current status of the Fargate profile.
tags (dict) --
The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
Exceptions
Returns descriptive information about an Amazon EKS node group.
See also: AWS API Documentation
Request Syntax
response = client.describe_nodegroup(
clusterName='string',
nodegroupName='string'
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the node group.
[REQUIRED]
The name of the node group to describe.
dict
Response Syntax
{
'nodegroup': {
'nodegroupName': 'string',
'nodegroupArn': 'string',
'clusterName': 'string',
'version': 'string',
'releaseVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'|'DEGRADED',
'capacityType': 'ON_DEMAND'|'SPOT',
'scalingConfig': {
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
'instanceTypes': [
'string',
],
'subnets': [
'string',
],
'remoteAccess': {
'ec2SshKey': 'string',
'sourceSecurityGroups': [
'string',
]
},
'amiType': 'AL2_x86_64'|'AL2_x86_64_GPU'|'AL2_ARM_64',
'nodeRole': 'string',
'labels': {
'string': 'string'
},
'resources': {
'autoScalingGroups': [
{
'name': 'string'
},
],
'remoteAccessSecurityGroup': 'string'
},
'diskSize': 123,
'health': {
'issues': [
{
'code': 'AutoScalingGroupNotFound'|'AutoScalingGroupInvalidConfiguration'|'Ec2SecurityGroupNotFound'|'Ec2SecurityGroupDeletionFailure'|'Ec2LaunchTemplateNotFound'|'Ec2LaunchTemplateVersionMismatch'|'Ec2SubnetNotFound'|'Ec2SubnetInvalidConfiguration'|'IamInstanceProfileNotFound'|'IamLimitExceeded'|'IamNodeRoleNotFound'|'NodeCreationFailure'|'AsgInstanceLaunchFailures'|'InstanceLimitExceeded'|'InsufficientFreeAddresses'|'AccessDenied'|'InternalFailure'|'ClusterUnreachable',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'launchTemplate': {
'name': 'string',
'version': 'string',
'id': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
nodegroup (dict) --
The full description of your node group.
nodegroupName (string) --
The name associated with an Amazon EKS managed node group.
nodegroupArn (string) --
The Amazon Resource Name (ARN) associated with the managed node group.
clusterName (string) --
The name of the cluster that the managed node group resides in.
version (string) --
The Kubernetes version of the managed node group.
releaseVersion (string) --
If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was created.
modifiedAt (datetime) --
The Unix epoch timestamp in seconds for when the managed node group was last modified.
status (string) --
The current status of the managed node group.
capacityType (string) --
The capacity type of your managed node group.
scalingConfig (dict) --
The scaling configuration details for the Auto Scaling group that is associated with your node group.
minSize (integer) --
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
maxSize (integer) --
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
desiredSize (integer) --
The current number of worker nodes that the managed node group should maintain.
instanceTypes (list) --
If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null .
subnets (list) --
The subnets that were specified for the Auto Scaling group that is associated with your node group.
remoteAccess (dict) --
If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null .
ec2SshKey (string) --
The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .
sourceSecurityGroups (list) --
The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .
amiType (string) --
If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM . For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.
nodeRole (string) --
The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.
labels (dict) --
The Kubernetes labels applied to the nodes in the node group.
Note
Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
resources (dict) --
The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
autoScalingGroups (list) --
The Auto Scaling groups associated with the node group.
(dict) --
An Auto Scaling group that is associated with an Amazon EKS managed node group.
name (string) --
The name of the Auto Scaling group associated with an Amazon EKS managed node group.
remoteAccessSecurityGroup (string) --
The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.
diskSize (integer) --
If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null .
health (dict) --
The health status of the node group. If there are issues with your node group's health, they are listed here.
issues (list) --
Any issues that are associated with the node group.
(dict) --
An object representing an issue with an Amazon EKS resource.
code (string) --
A brief description of the error.
message (string) --
The error message associated with the issue.
resourceIds (list) --
The AWS resources that are afflicted by this issue.
launchTemplate (dict) --
If a launch template was used to create the node group, then this is the launch template that was used.
name (string) --
The name of the launch template.
version (string) --
The version of the launch template to use. If no version is specified, then the template's default version is used.
id (string) --
The ID of the launch template.
tags (dict) --
The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Exceptions
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update is Succeeded , the update is complete. If an update fails, the status is Failed , and an error detail explains the reason for the failure.
See also: AWS API Documentation
Request Syntax
response = client.describe_update(
name='string',
updateId='string',
nodegroupName='string',
addonName='string'
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the update.
[REQUIRED]
The ID of the update to describe.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
The full description of the specified update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Lists the available add-ons.
See also: AWS API Documentation
Request Syntax
response = client.list_addons(
clusterName='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the cluster.
The nextToken value returned from a previous paginated ListAddonsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'addons': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
addons (list) --
A list of available add-ons.
nextToken (string) --
The nextToken value returned from a previous paginated ListAddonsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
Exceptions
Lists the Amazon EKS clusters in your AWS account in the specified Region.
See also: AWS API Documentation
Request Syntax
response = client.list_clusters(
maxResults=123,
nextToken='string'
)
The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
dict
Response Syntax
{
'clusters': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
clusters (list) --
A list of all of the clusters for your account in the specified Region.
nextToken (string) --
The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Examples
This example command lists all of your available clusters in your default region.
response = client.list_clusters(
)
print(response)
Expected Output:
{
'clusters': [
'devel',
'prod',
],
'ResponseMetadata': {
'...': '...',
},
}
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
See also: AWS API Documentation
Request Syntax
response = client.list_fargate_profiles(
clusterName='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster that you would like to listFargate profiles in.
dict
Response Syntax
{
'fargateProfileNames': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
fargateProfileNames (list) --
A list of all of the Fargate profiles associated with the specified cluster.
nextToken (string) --
The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region. Self-managed node groups are not listed.
See also: AWS API Documentation
Request Syntax
response = client.list_nodegroups(
clusterName='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster that you would like to list node groups in.
dict
Response Syntax
{
'nodegroups': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
nodegroups (list) --
A list of all of the node groups associated with the specified cluster.
nextToken (string) --
The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
List the tags for an Amazon EKS resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags for the resource.
Exceptions
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
See also: AWS API Documentation
Request Syntax
response = client.list_updates(
name='string',
nodegroupName='string',
addonName='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The name of the Amazon EKS cluster to list updates for.
dict
Response Syntax
{
'updateIds': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
updateIds (list) --
A list of all the updates for the specified cluster and Region.
nextToken (string) --
The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and worker nodes associated with the cluster.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
[REQUIRED]
The tags to add to the resource. A tag is an array of key-value pairs.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
[REQUIRED]
The keys of the tags to be removed.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates an Amazon EKS add-on.
See also: AWS API Documentation
Request Syntax
response = client.update_addon(
clusterName='string',
addonName='string',
addonVersion='string',
serviceAccountRoleArn='string',
resolveConflicts='OVERWRITE'|'NONE',
clientRequestToken='string'
)
[REQUIRED]
The name of the cluster.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide .
Note
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide .
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
Updates an Amazon EKS cluster configuration. 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.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the * Amazon EKS User Guide * .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing .
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
Warning
At this time, you can not update the subnets or security group IDs for an existing cluster.
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_cluster_config(
name='string',
resourcesVpcConfig={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
logging={
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
clientRequestToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster to update.
An object representing the VPC configuration to use for an Amazon EKS cluster.
Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:
For more information, see Amazon EKS security group considerations in the * Amazon EKS User Guide * .
Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true , which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false , which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access Control in the * Amazon EKS User Guide * .
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the * Amazon EKS User Guide * .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing .
The cluster control plane logging configuration for your cluster.
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
The available cluster control plane log types.
If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.update_cluster_version(
name='string',
version='string',
clientRequestToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster to update.
[REQUIRED]
The desired Kubernetes version following a successful update.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
The full description of the specified update
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_nodegroup_config(
clusterName='string',
nodegroupName='string',
labels={
'addOrUpdateLabels': {
'string': 'string'
},
'removeLabels': [
'string',
]
},
scalingConfig={
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
clientRequestToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster that the managed node group resides in.
[REQUIRED]
The name of the managed node group to update.
The Kubernetes labels to be applied to the nodes in the node group after the update.
Kubernetes labels to be added or updated.
Kubernetes labels to be removed.
The scaling configuration details for the Auto Scaling group after the update.
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
The current number of worker nodes that the managed node group should maintain.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
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 more information, see Amazon EKS optimized Amazon Linux 2 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.
See also: AWS API Documentation
Request Syntax
response = client.update_nodegroup_version(
clusterName='string',
nodegroupName='string',
version='string',
releaseVersion='string',
launchTemplate={
'name': 'string',
'version': 'string',
'id': 'string'
},
force=True|False,
clientRequestToken='string'
)
[REQUIRED]
The name of the Amazon EKS cluster that is associated with the managed node group to update.
[REQUIRED]
The name of the managed node group to update.
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.
The name of the launch template.
The version of the launch template to use. If no version is specified, then the template's default version is used.
The ID of the launch template.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AddonUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
Exceptions
The available paginators are:
paginator = client.get_paginator('describe_addon_versions')
Creates an iterator that will paginate through responses from EKS.Client.describe_addon_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
kubernetesVersion='string',
addonName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'addons': [
{
'addonName': 'string',
'type': 'string',
'addonVersions': [
{
'addonVersion': 'string',
'architecture': [
'string',
],
'compatibilities': [
{
'clusterVersion': 'string',
'platformVersions': [
'string',
],
'defaultVersion': True|False
},
]
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
addons (list) --
The list of available versions with Kubernetes version compatibility.
(dict) --
Information about an add-on.
addonName (string) --
The name of the add-on.
type (string) --
The type of the add-on.
addonVersions (list) --
An object that represents information about available add-on versions and compatible Kubernetes versions.
(dict) --
Information about an add-on version.
addonVersion (string) --
The version of the add-on.
architecture (list) --
The architectures that the version supports.
compatibilities (list) --
An object that represents the compatibilities of a version.
(dict) --
Compatibility information.
clusterVersion (string) --
The supported Kubernetes version of the cluster.
platformVersions (list) --
The supported compute platform.
defaultVersion (boolean) --
The supported default version.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_addons')
Creates an iterator that will paginate through responses from EKS.Client.list_addons().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
clusterName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the cluster.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'addons': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
addons (list) --
A list of available add-ons.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_clusters')
Creates an iterator that will paginate through responses from EKS.Client.list_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'clusters': [
'string',
],
'NextToken': 'string'
}
Response Structure
A list of all of the clusters for your account in the specified Region.
A token to resume pagination.
paginator = client.get_paginator('list_fargate_profiles')
Creates an iterator that will paginate through responses from EKS.Client.list_fargate_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
clusterName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Amazon EKS cluster that you would like to listFargate profiles in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'fargateProfileNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
fargateProfileNames (list) --
A list of all of the Fargate profiles associated with the specified cluster.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_nodegroups')
Creates an iterator that will paginate through responses from EKS.Client.list_nodegroups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
clusterName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Amazon EKS cluster that you would like to list node groups in.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'nodegroups': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
nodegroups (list) --
A list of all of the node groups associated with the specified cluster.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_updates')
Creates an iterator that will paginate through responses from EKS.Client.list_updates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
name='string',
nodegroupName='string',
addonName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Amazon EKS cluster to list updates for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'updateIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
updateIds (list) --
A list of all the updates for the specified cluster and Region.
NextToken (string) --
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('addon_active')
Polls EKS.Client.describe_addon() every 10 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
clusterName='string',
addonName='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the cluster.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 10
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('addon_deleted')
Polls EKS.Client.describe_addon() every 10 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
clusterName='string',
addonName='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the cluster.
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 10
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('cluster_active')
Polls EKS.Client.describe_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
name='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the cluster to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('cluster_deleted')
Polls EKS.Client.describe_cluster() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
name='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the cluster to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 40
None
waiter = client.get_waiter('nodegroup_active')
Polls EKS.Client.describe_nodegroup() every 30 seconds until a successful state is reached. An error is returned after 80 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
clusterName='string',
nodegroupName='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the node group.
[REQUIRED]
The name of the node group to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 80
None
waiter = client.get_waiter('nodegroup_deleted')
Polls EKS.Client.describe_nodegroup() every 30 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
clusterName='string',
nodegroupName='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The name of the Amazon EKS cluster associated with the node group.
[REQUIRED]
The name of the node group to describe.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 40
None