2026/08/25 - Amazon Elastic Kubernetes Service - 7 updated api methods
Changes This feature would give customers the ability to tune TerminatedPodGcThreshold configuration in an Amazon EKS cluster.
{'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}
Response {'cluster': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}}
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 Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It 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 nodes (for example, to support kubectl exec, logs, and proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over 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. The endpoint domain name and IP address family depends on the value of the ipFamily for the cluster. 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 .
In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide.
See also: AWS API Documentation
Request Syntax
client.create_cluster(
name='string',
version='string',
roleArn='string',
resourcesVpcConfig={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
kubernetesNetworkConfig={
'serviceIpv4Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
logging={
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
clientRequestToken='string',
tags={
'string': 'string'
},
encryptionConfig=[
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
outpostConfig={
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
accessConfig={
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
bootstrapSelfManagedAddons=True|False,
upgradePolicy={
'supportType': 'STANDARD'|'EXTENDED'
},
zonalShiftConfig={
'enabled': True|False
},
remoteNetworkConfig={
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
computeConfig={
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
storageConfig={
'blockStorage': {
'enabled': True|False
}
},
deletionProtection=True|False,
controlPlaneScalingConfig={
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
kubeApiServerConfig={
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
kubeSchedulerConfig={
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
kubeControllerManagerConfig={
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
)
string
[REQUIRED]
The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the cluster in.
string
The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
dict
[REQUIRED]
The VPC configuration that's 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. However, we recommend that you use a dedicated security group for your cluster control plane.
subnetIds (list) --
Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
(string) --
securityGroupIds (list) --
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your 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 .
(string) --
endpointPublicAccess (boolean) --
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. The endpoint domain name and IP address family depends on the value of the ipFamily for the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
endpointPrivateAccess (boolean) --
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
Specifies the control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane and you don't need to configure NAT gateways or other routing infrastructure for control plane traffic. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets. You are responsible for ensuring that the control plane can reach required endpoints such as webhook servers and OIDC providers. The default value is AWS_MANAGED. Once set to CUSTOMER_ROUTED, this setting cannot be changed back to AWS_MANAGED on the same cluster.
Learn more about control plane egress routing in the Amazon EKS User Guide.
dict
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
Don't specify a value if you select ipv6 for ipFamily. 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:
Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.
Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.
Between /24 and /12.
ipFamily (string) --
Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, ipv4 is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify ipv6, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't specify ipv6 for clusters in China Regions.
You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure that your VPC meets the requirements listed in the considerations listed in Assigning IPv6 addresses to pods and services in the Amazon EKS User Guide. Kubernetes assigns services IPv6 addresses from the unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from the subnet's IPv6 CIDR.
elasticLoadBalancing (dict) --
Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
dict
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 .
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.
(string) --
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.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
dict
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.
outpostArns (list) -- [REQUIRED]
The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. Only a single Outpost ARN is supported.
(string) --
controlPlaneInstanceType (string) -- [REQUIRED]
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all control plane instances and cannot be changed after cluster creation.
For more information, see Capacity considerations in the Amazon EKS User Guide.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation.
spreadLevel (string) --
Optional parameter to specify the placement group spread level for control plane instances. If not provided, Amazon EKS will deploy control plane instances without a placement group.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all etcd instances and cannot be changed after cluster creation.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
Optional parameter to specify the placement group spread level for etcd instances. If not provided, Amazon EKS will deploy etcd instances without a placement group.
dict
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. The default value is true.
authenticationMode (string) --
The desired authentication mode for the cluster. If you create a cluster by using the EKS API, Amazon Web Services SDKs, or CloudFormation, the default is CONFIG_MAP. If you create the cluster by using the Amazon Web Services Management Console, the default value is API_AND_CONFIG_MAP.
boolean
If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
The default networking add-ons include vpc-cni, coredns, and kube-proxy.
Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
dict
New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
dict
Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.
You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .
enabled (boolean) --
If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
dict
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
dict
Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account
enabled (boolean) --
Request to enable or disable the compute capability on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the Amazon EKS User Guide.
dict
Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
blockStorage (dict) --
Request to configure EBS Block Storage settings for your EKS Auto Mode cluster.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
boolean
Indicates whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. This helps prevent accidental cluster deletion. Default value is false.
dict
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
dict
The Kubernetes API server configuration for the new cluster.
eventTtl (string) --
The duration that Kubernetes events are retained. Valid values are single-unit durations such as 30m or 1h.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
dict
The Kubernetes scheduler configuration for the new cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
dict
The Kubernetes controller manager configuration for the new cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler. Valid values are single-unit durations such as 15s or 1m.
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',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
'certificateAuthority': {
'data': 'string',
'active': {
'id': 'string',
'activatedBy': 'EKS'|'CUSTOMER'
}
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
'connectorConfig': {
'activationId': 'string',
'activationCode': 'string',
'activationExpiry': datetime(2015, 1, 1),
'provider': 'string',
'roleArn': 'string'
},
'id': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'outpostConfig': {
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
'accessConfig': {
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
'upgradePolicy': {
'supportType': 'STANDARD'|'EXTENDED'
},
'zonalShiftConfig': {
'enabled': True|False
},
'remoteNetworkConfig': {
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
'computeConfig': {
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
'storageConfig': {
'blockStorage': {
'enabled': True|False
}
},
'deletionProtection': True|False,
'controlPlaneScalingConfig': {
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
'kubeApiServerConfig': {
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your new cluster.
name (string) --
The name of your cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp at object creation.
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 Amazon Web Services 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.
(string) --
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
(string) --
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) --
Whether the public API server endpoint is enabled.
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.
Learn more about control plane egress routing in the Amazon EKS User Guide.
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. 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 can't be changed.
serviceIpv6Cidr (string) --
The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.
ipFamily (string) --
The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
elasticLoadBalancing (dict) --
Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
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.
(string) --
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) --
An object representing the OpenID Connect identity provider information.
issuer (string) --
The issuer URL for the OIDC 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.
active (dict) --
An object identifying the certificate authority that is currently signing certificates for the cluster.
id (string) --
The unique identifier of the certificate authority that is currently signing certificates for the cluster.
activatedBy (string) --
The entity that activated the current signing certificate authority, either CUSTOMER or EKS.
clientRequestToken (string) --
A 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 about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
tags (dict) --
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
connectorConfig (dict) --
The configuration used to connect to a cluster for registration.
activationId (string) --
A unique ID associated with the cluster for registration purposes.
activationCode (string) --
A unique code associated with the cluster for registration purposes.
activationExpiry (datetime) --
The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
provider (string) --
The cluster's cloud service provider.
roleArn (string) --
The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
id (string) --
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
health (dict) --
An object representing the health of your Amazon EKS cluster.
issues (list) --
An object representing the health issues of your Amazon EKS cluster.
(dict) --
An issue with your Amazon EKS cluster.
code (string) --
The error code of the issue.
message (string) --
A description of the issue.
resourceIds (list) --
The resource IDs that the issue relates to.
(string) --
outpostConfig (dict) --
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
outpostArns (list) --
The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
(string) --
controlPlaneInstanceType (string) --
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances.
spreadLevel (string) --
The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
accessConfig (dict) --
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
authenticationMode (string) --
The current authentication mode of the cluster.
upgradePolicy (dict) --
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
zonalShiftConfig (dict) --
The configuration for zonal shift for the cluster.
enabled (boolean) --
Whether the zonal shift is enabled.
remoteNetworkConfig (dict) --
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
computeConfig (dict) --
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
storageConfig (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
blockStorage (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
deletionProtection (boolean) --
The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
controlPlaneScalingConfig (dict) --
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration for the cluster.
eventTtl (string) --
The duration that Kubernetes events are retained.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration for the cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration for the cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler.
{'cluster': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}}
Deletes an Amazon EKS cluster control plane.
If you have active services and ingress resources 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 DeleteNodgroup and DeleteFargateProfile.
See also: AWS API Documentation
Request Syntax
client.delete_cluster(
name='string'
)
string
[REQUIRED]
The name of the cluster to delete.
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',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
'certificateAuthority': {
'data': 'string',
'active': {
'id': 'string',
'activatedBy': 'EKS'|'CUSTOMER'
}
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
'connectorConfig': {
'activationId': 'string',
'activationCode': 'string',
'activationExpiry': datetime(2015, 1, 1),
'provider': 'string',
'roleArn': 'string'
},
'id': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'outpostConfig': {
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
'accessConfig': {
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
'upgradePolicy': {
'supportType': 'STANDARD'|'EXTENDED'
},
'zonalShiftConfig': {
'enabled': True|False
},
'remoteNetworkConfig': {
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
'computeConfig': {
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
'storageConfig': {
'blockStorage': {
'enabled': True|False
}
},
'deletionProtection': True|False,
'controlPlaneScalingConfig': {
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
'kubeApiServerConfig': {
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of the cluster to delete.
name (string) --
The name of your cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp at object creation.
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 Amazon Web Services 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.
(string) --
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
(string) --
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) --
Whether the public API server endpoint is enabled.
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.
Learn more about control plane egress routing in the Amazon EKS User Guide.
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. 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 can't be changed.
serviceIpv6Cidr (string) --
The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.
ipFamily (string) --
The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
elasticLoadBalancing (dict) --
Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
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.
(string) --
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) --
An object representing the OpenID Connect identity provider information.
issuer (string) --
The issuer URL for the OIDC 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.
active (dict) --
An object identifying the certificate authority that is currently signing certificates for the cluster.
id (string) --
The unique identifier of the certificate authority that is currently signing certificates for the cluster.
activatedBy (string) --
The entity that activated the current signing certificate authority, either CUSTOMER or EKS.
clientRequestToken (string) --
A 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 about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
tags (dict) --
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
connectorConfig (dict) --
The configuration used to connect to a cluster for registration.
activationId (string) --
A unique ID associated with the cluster for registration purposes.
activationCode (string) --
A unique code associated with the cluster for registration purposes.
activationExpiry (datetime) --
The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
provider (string) --
The cluster's cloud service provider.
roleArn (string) --
The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
id (string) --
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
health (dict) --
An object representing the health of your Amazon EKS cluster.
issues (list) --
An object representing the health issues of your Amazon EKS cluster.
(dict) --
An issue with your Amazon EKS cluster.
code (string) --
The error code of the issue.
message (string) --
A description of the issue.
resourceIds (list) --
The resource IDs that the issue relates to.
(string) --
outpostConfig (dict) --
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
outpostArns (list) --
The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
(string) --
controlPlaneInstanceType (string) --
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances.
spreadLevel (string) --
The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
accessConfig (dict) --
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
authenticationMode (string) --
The current authentication mode of the cluster.
upgradePolicy (dict) --
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
zonalShiftConfig (dict) --
The configuration for zonal shift for the cluster.
enabled (boolean) --
Whether the zonal shift is enabled.
remoteNetworkConfig (dict) --
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
computeConfig (dict) --
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
storageConfig (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
blockStorage (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
deletionProtection (boolean) --
The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
controlPlaneScalingConfig (dict) --
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration for the cluster.
eventTtl (string) --
The duration that Kubernetes events are retained.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration for the cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration for the cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler.
{'cluster': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}}
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.
See also: AWS API Documentation
Request Syntax
client.deregister_cluster(
name='string'
)
string
[REQUIRED]
The name of the connected cluster to deregister.
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',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
'certificateAuthority': {
'data': 'string',
'active': {
'id': 'string',
'activatedBy': 'EKS'|'CUSTOMER'
}
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
'connectorConfig': {
'activationId': 'string',
'activationCode': 'string',
'activationExpiry': datetime(2015, 1, 1),
'provider': 'string',
'roleArn': 'string'
},
'id': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'outpostConfig': {
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
'accessConfig': {
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
'upgradePolicy': {
'supportType': 'STANDARD'|'EXTENDED'
},
'zonalShiftConfig': {
'enabled': True|False
},
'remoteNetworkConfig': {
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
'computeConfig': {
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
'storageConfig': {
'blockStorage': {
'enabled': True|False
}
},
'deletionProtection': True|False,
'controlPlaneScalingConfig': {
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
'kubeApiServerConfig': {
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
An object representing an Amazon EKS cluster.
name (string) --
The name of your cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp at object creation.
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 Amazon Web Services 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.
(string) --
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
(string) --
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) --
Whether the public API server endpoint is enabled.
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.
Learn more about control plane egress routing in the Amazon EKS User Guide.
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. 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 can't be changed.
serviceIpv6Cidr (string) --
The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.
ipFamily (string) --
The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
elasticLoadBalancing (dict) --
Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
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.
(string) --
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) --
An object representing the OpenID Connect identity provider information.
issuer (string) --
The issuer URL for the OIDC 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.
active (dict) --
An object identifying the certificate authority that is currently signing certificates for the cluster.
id (string) --
The unique identifier of the certificate authority that is currently signing certificates for the cluster.
activatedBy (string) --
The entity that activated the current signing certificate authority, either CUSTOMER or EKS.
clientRequestToken (string) --
A 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 about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
tags (dict) --
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
connectorConfig (dict) --
The configuration used to connect to a cluster for registration.
activationId (string) --
A unique ID associated with the cluster for registration purposes.
activationCode (string) --
A unique code associated with the cluster for registration purposes.
activationExpiry (datetime) --
The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
provider (string) --
The cluster's cloud service provider.
roleArn (string) --
The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
id (string) --
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
health (dict) --
An object representing the health of your Amazon EKS cluster.
issues (list) --
An object representing the health issues of your Amazon EKS cluster.
(dict) --
An issue with your Amazon EKS cluster.
code (string) --
The error code of the issue.
message (string) --
A description of the issue.
resourceIds (list) --
The resource IDs that the issue relates to.
(string) --
outpostConfig (dict) --
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
outpostArns (list) --
The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
(string) --
controlPlaneInstanceType (string) --
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances.
spreadLevel (string) --
The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
accessConfig (dict) --
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
authenticationMode (string) --
The current authentication mode of the cluster.
upgradePolicy (dict) --
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
zonalShiftConfig (dict) --
The configuration for zonal shift for the cluster.
enabled (boolean) --
Whether the zonal shift is enabled.
remoteNetworkConfig (dict) --
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
computeConfig (dict) --
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
storageConfig (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
blockStorage (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
deletionProtection (boolean) --
The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
controlPlaneScalingConfig (dict) --
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration for the cluster.
eventTtl (string) --
The duration that Kubernetes events are retained.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration for the cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration for the cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler.
{'cluster': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}}
Describes 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 Creating or updating a kubeconfig file for an Amazon EKS cluster.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
name='string'
)
string
[REQUIRED]
The name of your cluster.
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',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
'certificateAuthority': {
'data': 'string',
'active': {
'id': 'string',
'activatedBy': 'EKS'|'CUSTOMER'
}
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
'connectorConfig': {
'activationId': 'string',
'activationCode': 'string',
'activationExpiry': datetime(2015, 1, 1),
'provider': 'string',
'roleArn': 'string'
},
'id': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'outpostConfig': {
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
'accessConfig': {
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
'upgradePolicy': {
'supportType': 'STANDARD'|'EXTENDED'
},
'zonalShiftConfig': {
'enabled': True|False
},
'remoteNetworkConfig': {
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
'computeConfig': {
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
'storageConfig': {
'blockStorage': {
'enabled': True|False
}
},
'deletionProtection': True|False,
'controlPlaneScalingConfig': {
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
'kubeApiServerConfig': {
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your specified cluster.
name (string) --
The name of your cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp at object creation.
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 Amazon Web Services 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.
(string) --
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
(string) --
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) --
Whether the public API server endpoint is enabled.
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.
Learn more about control plane egress routing in the Amazon EKS User Guide.
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. 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 can't be changed.
serviceIpv6Cidr (string) --
The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.
ipFamily (string) --
The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
elasticLoadBalancing (dict) --
Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
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.
(string) --
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) --
An object representing the OpenID Connect identity provider information.
issuer (string) --
The issuer URL for the OIDC 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.
active (dict) --
An object identifying the certificate authority that is currently signing certificates for the cluster.
id (string) --
The unique identifier of the certificate authority that is currently signing certificates for the cluster.
activatedBy (string) --
The entity that activated the current signing certificate authority, either CUSTOMER or EKS.
clientRequestToken (string) --
A 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 about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
tags (dict) --
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
connectorConfig (dict) --
The configuration used to connect to a cluster for registration.
activationId (string) --
A unique ID associated with the cluster for registration purposes.
activationCode (string) --
A unique code associated with the cluster for registration purposes.
activationExpiry (datetime) --
The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
provider (string) --
The cluster's cloud service provider.
roleArn (string) --
The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
id (string) --
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
health (dict) --
An object representing the health of your Amazon EKS cluster.
issues (list) --
An object representing the health issues of your Amazon EKS cluster.
(dict) --
An issue with your Amazon EKS cluster.
code (string) --
The error code of the issue.
message (string) --
A description of the issue.
resourceIds (list) --
The resource IDs that the issue relates to.
(string) --
outpostConfig (dict) --
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
outpostArns (list) --
The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
(string) --
controlPlaneInstanceType (string) --
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances.
spreadLevel (string) --
The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
accessConfig (dict) --
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
authenticationMode (string) --
The current authentication mode of the cluster.
upgradePolicy (dict) --
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
zonalShiftConfig (dict) --
The configuration for zonal shift for the cluster.
enabled (boolean) --
Whether the zonal shift is enabled.
remoteNetworkConfig (dict) --
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
computeConfig (dict) --
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
storageConfig (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
blockStorage (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
deletionProtection (boolean) --
The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
controlPlaneScalingConfig (dict) --
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration for the cluster.
eventTtl (string) --
The duration that Kubernetes events are retained.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration for the cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration for the cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler.
{'clusterVersions': {'controlPlaneComponentConfig': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': {'constraints': {'max': 'integer',
'min': 'integer'},
'defaultValue': 'integer'}}}},
'controlPlaneScalingTiers': {'controlPlaneComponentConfigOverrides': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': {'constraints': {'max': 'integer',
'min': 'integer'},
'defaultValue': 'integer'}}}}}}}
Lists available Kubernetes versions for Amazon EKS clusters.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_versions(
clusterType='string',
maxResults=123,
nextToken='string',
defaultOnly=True|False,
includeAll=True|False,
clusterVersions=[
'string',
],
status='unsupported'|'standard-support'|'extended-support',
versionStatus='UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT'
)
string
The type of cluster to filter versions by.
integer
Maximum number of results to return.
string
Pagination token for the next set of results.
boolean
Filter to show only default versions.
boolean
Include all available versions in the response.
list
List of specific cluster versions to describe.
(string) --
string
Filter versions by their current status.
string
Filter versions by their current status.
dict
Response Syntax
{
'nextToken': 'string',
'clusterVersions': [
{
'clusterVersion': 'string',
'clusterType': 'string',
'defaultPlatformVersion': 'string',
'defaultVersion': True|False,
'releaseDate': datetime(2015, 1, 1),
'endOfStandardSupportDate': datetime(2015, 1, 1),
'endOfExtendedSupportDate': datetime(2015, 1, 1),
'status': 'unsupported'|'standard-support'|'extended-support',
'versionStatus': 'UNSUPPORTED'|'STANDARD_SUPPORT'|'EXTENDED_SUPPORT',
'kubernetesPatchVersion': 'string',
'controlPlaneScalingTiers': [
{
'tierName': 'string',
'apiRequestConcurrency': 123,
'podSchedulingRatePerSecond': 123,
'clusterDatabaseSizeGb': 123,
'controlPlaneComponentConfigOverrides': {
'kubeApiServerConfig': {
'eventTtl': {
'defaultValue': 'string',
'constraints': {
'min': 'string',
'max': 'string'
}
},
'serviceNodePortRange': {
'defaultValue': {
'minPort': 123,
'maxPort': 123
},
'constraints': {
'minPort': {
'min': 123,
'max': 123
},
'maxPort': {
'min': 123,
'max': 123
}
}
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'defaultValue': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
},
'constraints': {
'scoringStrategy': {
'allowedValues': [
'string',
]
},
'resources': {
'name': {
'allowedValues': [
'string',
]
},
'weight': {
'min': 123,
'max': 123
}
}
}
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': {
'defaultValue': 123,
'constraints': {
'min': 123,
'max': 123
}
}
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': {
'defaultValue': 'string',
'constraints': {
'min': 'string',
'max': 'string'
}
}
}
}
}
},
],
'controlPlaneComponentConfig': {
'kubeApiServerConfig': {
'eventTtl': {
'defaultValue': 'string',
'constraints': {
'min': 'string',
'max': 'string'
}
},
'serviceNodePortRange': {
'defaultValue': {
'minPort': 123,
'maxPort': 123
},
'constraints': {
'minPort': {
'min': 123,
'max': 123
},
'maxPort': {
'min': 123,
'max': 123
}
}
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'defaultValue': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
},
'constraints': {
'scoringStrategy': {
'allowedValues': [
'string',
]
},
'resources': {
'name': {
'allowedValues': [
'string',
]
},
'weight': {
'min': 123,
'max': 123
}
}
}
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': {
'defaultValue': 123,
'constraints': {
'min': 123,
'max': 123
}
}
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': {
'defaultValue': 'string',
'constraints': {
'min': 'string',
'max': 'string'
}
}
}
}
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
Pagination token for the next set of results.
clusterVersions (list) --
List of cluster version information objects.
(dict) --
Contains details about a specific EKS cluster version.
clusterVersion (string) --
The Kubernetes version for the cluster.
clusterType (string) --
The type of cluster this version is for.
defaultPlatformVersion (string) --
Default platform version for this Kubernetes version.
defaultVersion (boolean) --
Indicates if this is a default version.
releaseDate (datetime) --
The release date of this cluster version.
endOfStandardSupportDate (datetime) --
Date when standard support ends for this version.
endOfExtendedSupportDate (datetime) --
Date when extended support ends for this version.
status (string) --
Current status of this cluster version.
versionStatus (string) --
Current status of this cluster version.
kubernetesPatchVersion (string) --
The patch version of Kubernetes for this cluster version.
controlPlaneScalingTiers (list) --
The available provisioned control plane scaling tiers and their capabilities for this Kubernetes version.
(dict) --
Information about a provisioned control plane scaling tier.
tierName (string) --
The name of the scaling tier.
apiRequestConcurrency (integer) --
The maximum API request concurrency supported by this tier.
podSchedulingRatePerSecond (integer) --
The maximum pod scheduling rate per second supported by this tier.
clusterDatabaseSizeGb (integer) --
The maximum cluster database size in GB supported by this tier.
controlPlaneComponentConfigOverrides (dict) --
The control plane component configuration overrides specific to this scaling tier.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration defaults and constraints.
eventTtl (dict) --
The event TTL configuration with default value and constraints.
defaultValue (string) --
The default value for the duration parameter.
constraints (dict) --
The constraints for the duration parameter.
min (string) --
The minimum allowed duration value.
max (string) --
The maximum allowed duration value.
serviceNodePortRange (dict) --
The service node port range configuration with default value and constraints.
defaultValue (dict) --
The default port range value.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
constraints (dict) --
The constraints for the port range parameter.
minPort (dict) --
The constraints for the minimum port value.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
maxPort (dict) --
The constraints for the maximum port value.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration defaults and constraints.
nodeResourcesFit (dict) --
The NodeResourcesFit configuration with default value and constraints.
scoringStrategy (dict) --
The scoring strategy configuration with default value and constraints.
defaultValue (dict) --
The default scoring strategy.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
constraints (dict) --
The constraints for the scoring strategy.
scoringStrategy (dict) --
The allowed values for the scoring strategy type.
allowedValues (list) --
The list of allowed values.
(string) --
resources (dict) --
The constraints for resource weights.
name (dict) --
The allowed values for resource names.
allowedValues (list) --
The list of allowed values.
(string) --
weight (dict) --
The allowed range for resource weight values.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration defaults and constraints.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration with default value and constraints.
terminatedPodGcThreshold (dict) --
The terminated pod garbage collection threshold configuration with default value and constraints.
defaultValue (integer) --
The default value for the integer parameter.
constraints (dict) --
The constraints for the integer parameter.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration with default value and constraints.
horizontalPodAutoscalerSyncPeriod (dict) --
The HPA sync period configuration with default value and constraints.
defaultValue (string) --
The default value for the duration parameter.
constraints (dict) --
The constraints for the duration parameter.
min (string) --
The minimum allowed duration value.
max (string) --
The maximum allowed duration value.
controlPlaneComponentConfig (dict) --
The default control plane component configuration and constraints for this Kubernetes version.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration defaults and constraints.
eventTtl (dict) --
The event TTL configuration with default value and constraints.
defaultValue (string) --
The default value for the duration parameter.
constraints (dict) --
The constraints for the duration parameter.
min (string) --
The minimum allowed duration value.
max (string) --
The maximum allowed duration value.
serviceNodePortRange (dict) --
The service node port range configuration with default value and constraints.
defaultValue (dict) --
The default port range value.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
constraints (dict) --
The constraints for the port range parameter.
minPort (dict) --
The constraints for the minimum port value.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
maxPort (dict) --
The constraints for the maximum port value.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration defaults and constraints.
nodeResourcesFit (dict) --
The NodeResourcesFit configuration with default value and constraints.
scoringStrategy (dict) --
The scoring strategy configuration with default value and constraints.
defaultValue (dict) --
The default scoring strategy.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
constraints (dict) --
The constraints for the scoring strategy.
scoringStrategy (dict) --
The allowed values for the scoring strategy type.
allowedValues (list) --
The list of allowed values.
(string) --
resources (dict) --
The constraints for resource weights.
name (dict) --
The allowed values for resource names.
allowedValues (list) --
The list of allowed values.
(string) --
weight (dict) --
The allowed range for resource weight values.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration defaults and constraints.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration with default value and constraints.
terminatedPodGcThreshold (dict) --
The terminated pod garbage collection threshold configuration with default value and constraints.
defaultValue (integer) --
The default value for the integer parameter.
constraints (dict) --
The constraints for the integer parameter.
min (integer) --
The minimum allowed value.
max (integer) --
The maximum allowed value.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration with default value and constraints.
horizontalPodAutoscalerSyncPeriod (dict) --
The HPA sync period configuration with default value and constraints.
defaultValue (string) --
The default value for the duration parameter.
constraints (dict) --
The constraints for the duration parameter.
min (string) --
The minimum allowed duration value.
max (string) --
The maximum allowed duration value.
{'cluster': {'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}}
Connects a Kubernetes cluster to the Amazon EKS control plane.
Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.
Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.
After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.
See also: AWS API Documentation
Request Syntax
client.register_cluster(
name='string',
connectorConfig={
'roleArn': 'string',
'provider': 'EKS_ANYWHERE'|'ANTHOS'|'GKE'|'AKS'|'OPENSHIFT'|'TANZU'|'RANCHER'|'EC2'|'OTHER'
},
clientRequestToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
A unique name for this cluster in your Amazon Web Services Region.
dict
[REQUIRED]
The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.
roleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.
provider (string) -- [REQUIRED]
The cloud provider for the target cluster to connect.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
'logging': {
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
'identity': {
'oidc': {
'issuer': 'string'
}
},
'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
'certificateAuthority': {
'data': 'string',
'active': {
'id': 'string',
'activatedBy': 'EKS'|'CUSTOMER'
}
},
'clientRequestToken': 'string',
'platformVersion': 'string',
'tags': {
'string': 'string'
},
'encryptionConfig': [
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
'connectorConfig': {
'activationId': 'string',
'activationCode': 'string',
'activationExpiry': datetime(2015, 1, 1),
'provider': 'string',
'roleArn': 'string'
},
'id': 'string',
'health': {
'issues': [
{
'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
'message': 'string',
'resourceIds': [
'string',
]
},
]
},
'outpostConfig': {
'outpostArns': [
'string',
],
'controlPlaneInstanceType': 'string',
'controlPlanePlacement': {
'groupName': 'string',
'spreadLevel': 'host'|'rack'
},
'etcdInstanceType': 'string',
'etcdPlacement': {
'spreadLevel': 'host'|'rack'
}
},
'accessConfig': {
'bootstrapClusterCreatorAdminPermissions': True|False,
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
'upgradePolicy': {
'supportType': 'STANDARD'|'EXTENDED'
},
'zonalShiftConfig': {
'enabled': True|False
},
'remoteNetworkConfig': {
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
'computeConfig': {
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
'storageConfig': {
'blockStorage': {
'enabled': True|False
}
},
'deletionProtection': True|False,
'controlPlaneScalingConfig': {
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
'kubeApiServerConfig': {
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
'kubeSchedulerConfig': {
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
'kubeControllerManagerConfig': {
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
An object representing an Amazon EKS cluster.
name (string) --
The name of your cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp at object creation.
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 Amazon Web Services 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.
(string) --
securityGroupIds (list) --
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.
(string) --
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) --
Whether the public API server endpoint is enabled.
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
The current control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets.
Learn more about control plane egress routing in the Amazon EKS User Guide.
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. 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 can't be changed.
serviceIpv6Cidr (string) --
The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.
ipFamily (string) --
The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.
elasticLoadBalancing (dict) --
Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
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.
(string) --
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) --
An object representing the OpenID Connect identity provider information.
issuer (string) --
The issuer URL for the OIDC 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.
active (dict) --
An object identifying the certificate authority that is currently signing certificates for the cluster.
id (string) --
The unique identifier of the certificate authority that is currently signing certificates for the cluster.
activatedBy (string) --
The entity that activated the current signing certificate authority, either CUSTOMER or EKS.
clientRequestToken (string) --
A 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 about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
tags (dict) --
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
(string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
(string) --
provider (dict) --
Key Management Service (KMS) key. Either the ARN or the alias can be used.
keyArn (string) --
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.
connectorConfig (dict) --
The configuration used to connect to a cluster for registration.
activationId (string) --
A unique ID associated with the cluster for registration purposes.
activationCode (string) --
A unique code associated with the cluster for registration purposes.
activationExpiry (datetime) --
The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
provider (string) --
The cluster's cloud service provider.
roleArn (string) --
The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
id (string) --
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
health (dict) --
An object representing the health of your Amazon EKS cluster.
issues (list) --
An object representing the health issues of your Amazon EKS cluster.
(dict) --
An issue with your Amazon EKS cluster.
code (string) --
The error code of the issue.
message (string) --
A description of the issue.
resourceIds (list) --
The resource IDs that the issue relates to.
(string) --
outpostConfig (dict) --
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
outpostArns (list) --
The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
(string) --
controlPlaneInstanceType (string) --
The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances.
controlPlanePlacement (dict) --
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
groupName (string) --
The name of the placement group for the Kubernetes control plane instances.
spreadLevel (string) --
The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
etcdInstanceType (string) --
The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances.
etcdPlacement (dict) --
An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.
spreadLevel (string) --
The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts.
accessConfig (dict) --
The access configuration for the cluster.
bootstrapClusterCreatorAdminPermissions (boolean) --
Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
authenticationMode (string) --
The current authentication mode of the cluster.
upgradePolicy (dict) --
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
zonalShiftConfig (dict) --
The configuration for zonal shift for the cluster.
enabled (boolean) --
Whether the zonal shift is enabled.
remoteNetworkConfig (dict) --
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
computeConfig (dict) --
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
storageConfig (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
blockStorage (dict) --
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
deletionProtection (boolean) --
The current deletion protection setting for the cluster. When true, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When false, the cluster can be deleted normally. This setting only applies to clusters in an active state.
controlPlaneScalingConfig (dict) --
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
kubeApiServerConfig (dict) --
The Kubernetes API server configuration for the cluster.
eventTtl (string) --
The duration that Kubernetes events are retained.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
kubeSchedulerConfig (dict) --
The Kubernetes scheduler configuration for the cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
kubeControllerManagerConfig (dict) --
The Kubernetes controller manager configuration for the cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler.
{'kubeControllerManagerConfig': {'podGcControllerConfig': {'terminatedPodGcThreshold': 'integer'}}}
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 DescribeUpdate.
You can use this operation to do the following actions:
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 .
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 Cluster API server endpoint in the Amazon EKS User Guide .
You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide .
You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
You can also use this API operation to add, change, or remove the configuration in the cluster for EKS Hybrid Nodes. To remove the configuration, use the remoteNetworkConfig key with an object containing both subkeys with empty arrays for each. Here is an inline example: "remoteNetworkConfig": { "remoteNodeNetworks": [], "remotePodNetworks": [] }.
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
client.update_cluster_config(
name='string',
resourcesVpcConfig={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
],
'controlPlaneEgressMode': 'AWS_MANAGED'|'CUSTOMER_ROUTED'|'CUSTOMER_ISOLATED'
},
logging={
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
clientRequestToken='string',
accessConfig={
'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
},
upgradePolicy={
'supportType': 'STANDARD'|'EXTENDED'
},
zonalShiftConfig={
'enabled': True|False
},
computeConfig={
'enabled': True|False,
'nodePools': [
'string',
],
'nodeRoleArn': 'string'
},
kubernetesNetworkConfig={
'serviceIpv4Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6',
'elasticLoadBalancing': {
'enabled': True|False
}
},
storageConfig={
'blockStorage': {
'enabled': True|False
}
},
remoteNetworkConfig={
'remoteNodeNetworks': [
{
'cidrs': [
'string',
]
},
],
'remotePodNetworks': [
{
'cidrs': [
'string',
]
},
]
},
deletionProtection=True|False,
controlPlaneScalingConfig={
'tier': 'standard'|'tier-xl'|'tier-2xl'|'tier-4xl'|'tier-8xl'
},
kubeApiServerConfig={
'eventTtl': 'string',
'serviceNodePortRange': {
'minPort': 123,
'maxPort': 123
}
},
kubeSchedulerConfig={
'nodeResourcesFit': {
'scoringStrategy': {
'type': 'LeastAllocated'|'MostAllocated',
'resources': [
{
'name': 'string',
'weight': 123
},
]
}
}
},
kubeControllerManagerConfig={
'podGcControllerConfig': {
'terminatedPodGcThreshold': 123
},
'horizontalPodAutoscalerControllerConfig': {
'horizontalPodAutoscalerSyncPeriod': 'string'
}
}
)
string
[REQUIRED]
The name of the Amazon EKS cluster to update.
dict
An object representing the VPC configuration to use for the cluster update. You can use this parameter to update the control plane egress mode, the subnets used by the cluster, the security groups, and the endpoint access settings.
subnetIds (list) --
Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
(string) --
securityGroupIds (list) --
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your 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 .
(string) --
endpointPublicAccess (boolean) --
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. The endpoint domain name and IP address family depends on the value of the ipFamily for the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
endpointPrivateAccess (boolean) --
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 nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint 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 CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 and additionally ::/0 for dual-stack IPv6 clusters. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate Pod in the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .
Note that the public endpoints are dual-stack for only IPv6 clusters that are made after October 2024. You can't add IPv6 CIDR blocks to IPv4 clusters or IPv6 clusters that were made before October 2024.
(string) --
controlPlaneEgressMode (string) --
Specifies the control plane egress routing mode for the cluster. If the cluster is set to AWS_MANAGED, Amazon EKS manages the egress path from the control plane and you don't need to configure NAT gateways or other routing infrastructure for control plane traffic. If the cluster is set to CUSTOMER_ROUTED, you manage the egress path from the control plane in your VPC subnets. You are responsible for ensuring that the control plane can reach required endpoints such as webhook servers and OIDC providers. The default value is AWS_MANAGED. Once set to CUSTOMER_ROUTED, this setting cannot be changed back to AWS_MANAGED on the same cluster.
Learn more about control plane egress routing in the Amazon EKS User Guide.
dict
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 .
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.
(string) --
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.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The access configuration for the cluster.
authenticationMode (string) --
The desired authentication mode for the cluster.
dict
You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support.
supportType (string) --
If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
Learn more about EKS Extended Support in the Amazon EKS User Guide.
dict
Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.
You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .
enabled (boolean) --
If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.
dict
Update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability.
enabled (boolean) --
Request to enable or disable the compute capability on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account.
nodePools (list) --
Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the Amazon EKS User Guide.
(string) --
nodeRoleArn (string) --
The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the Amazon EKS User Guide.
dict
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
Don't specify a value if you select ipv6 for ipFamily. 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:
Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.
Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.
Between /24 and /12.
ipFamily (string) --
Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, ipv4 is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify ipv6, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't specify ipv6 for clusters in China Regions.
You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure that your VPC meets the requirements listed in the considerations listed in Assigning IPv6 addresses to pods and services in the Amazon EKS User Guide. Kubernetes assigns services IPv6 addresses from the unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from the subnet's IPv6 CIDR.
elasticLoadBalancing (dict) --
Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the Amazon EKS User Guide.
enabled (boolean) --
Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.
dict
Update the configuration of the block storage capability of your EKS Auto Mode cluster. For example, enable the capability.
blockStorage (dict) --
Request to configure EBS Block Storage settings for your EKS Auto Mode cluster.
enabled (boolean) --
Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.
dict
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
remoteNodeNetworks (list) --
The list of network CIDRs that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(dict) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
cidrs (list) --
A network CIDR that can contain hybrid nodes.
These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect.
Each host must allow outbound connection to the EKS cluster control plane on TCP ports 443 and 10250.
Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations.
Each host must allow TCP and UDP network connectivity to and from other hosts that are running CoreDNS on UDP port 53 for service and pod DNS names.
(string) --
remotePodNetworks (list) --
The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(dict) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
cidrs (list) --
A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.
These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn't available for on-premises and edge locations.
Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, 10.2.0.0/16).
It must satisfy the following requirements:
Each block must be within an IPv4 RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren't supported.
Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range.
(string) --
boolean
Specifies whether to enable or disable deletion protection for the cluster. When enabled ( true), the cluster cannot be deleted until deletion protection is explicitly disabled. When disabled ( false), the cluster can be deleted normally.
dict
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
tier (string) --
The control plane scaling tier configuration. Available options are standard, tier-xl, tier-2xl, tier-4xl, or tier-8xl. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.
dict
The Kubernetes API server configuration for the updated cluster.
eventTtl (string) --
The duration that Kubernetes events are retained. Valid values are single-unit durations such as 30m or 1h.
serviceNodePortRange (dict) --
The port range for NodePort services.
minPort (integer) --
The minimum port number in the range.
maxPort (integer) --
The maximum port number in the range.
dict
The Kubernetes scheduler configuration for the updated cluster.
nodeResourcesFit (dict) --
The node resource fit scoring configuration for the scheduler.
scoringStrategy (dict) --
The scoring strategy used to rank nodes during scheduling.
type (string) --
The scoring strategy type. Valid values are LeastAllocated or MostAllocated.
resources (list) --
The resource weights used for scoring nodes.
(dict) --
A resource weight entry for the scheduler scoring strategy.
name (string) --
The name of the resource (for example, cpu or memory).
weight (integer) --
The weight assigned to the resource for scoring. Must be between 1 and 100.
dict
The Kubernetes controller manager configuration for the updated cluster.
podGcControllerConfig (dict) --
The pod garbage collection controller configuration.
terminatedPodGcThreshold (integer) --
The number of terminated pods that can exist before the garbage collector starts deleting them.
horizontalPodAutoscalerControllerConfig (dict) --
The horizontal pod autoscaler controller configuration.
horizontalPodAutoscalerSyncPeriod (string) --
The interval between each sync of the horizontal pod autoscaler. Valid values are single-unit durations such as 15s or 1m.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate'|'AccessConfigUpdate'|'UpgradePolicyUpdate'|'ZonalShiftConfigUpdate'|'AutoModeUpdate'|'RemoteNetworkConfigUpdate'|'DeletionProtectionUpdate'|'CapabilityUpdate'|'ControlPlaneScalingConfigUpdate'|'VendedLogsUpdate'|'ControlPlaneEgressUpdate'|'VersionRollback'|'ControlPlaneComponentConfigUpdate'|'CertificateAuthorityUpdate',
'params': [
{
'type': 'Version'|'PlatformVersion'|'EndpointPrivateAccess'|'EndpointPublicAccess'|'ClusterLogging'|'DesiredSize'|'LabelsToAdd'|'LabelsToRemove'|'TaintsToAdd'|'TaintsToRemove'|'MaxSize'|'MinSize'|'ReleaseVersion'|'PublicAccessCidrs'|'LaunchTemplateName'|'LaunchTemplateVersion'|'IdentityProviderConfig'|'EncryptionConfig'|'AddonVersion'|'ServiceAccountRoleArn'|'ResolveConflicts'|'MaxUnavailable'|'MaxUnavailablePercentage'|'NodeRepairEnabled'|'UpdateStrategy'|'ConfigurationValues'|'SecurityGroups'|'Subnets'|'AuthenticationMode'|'PodIdentityAssociations'|'UpgradePolicy'|'ZonalShiftConfig'|'ComputeConfig'|'StorageConfig'|'KubernetesNetworkConfig'|'RemoteNetworkConfig'|'DeletionProtection'|'NodeRepairConfig'|'RoleArn'|'RoleMappingsToAddOrUpdate'|'RoleMappingsToRemove'|'NetworkAccess'|'VendedLogs'|'UpdatedTier'|'PreviousTier'|'WarmPoolEnabled'|'WarmPoolMaxGroupPreparedCapacity'|'WarmPoolMinSize'|'WarmPoolState'|'WarmPoolReuseOnScaleIn'|'ControlPlaneEgressMode'|'KubeApiServerConfig'|'KubeSchedulerConfig'|'KubeControllerManagerConfig'|'ActiveCertificateAuthority'|'TrustedCertificateAuthorities'|'CertificateAuthorityId'|'SigningStatus',
'value': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'errors': [
{
'errorCode': 'SubnetNotFound'|'SecurityGroupNotFound'|'EniLimitReached'|'IpNotAvailable'|'AccessDenied'|'OperationNotPermitted'|'VpcIdNotFound'|'Unknown'|'NodeCreationFailure'|'PodEvictionFailure'|'InsufficientFreeAddresses'|'ClusterUnreachable'|'InsufficientNumberOfReplicas'|'ConfigurationConflict'|'AdmissionRequestDenied'|'UnsupportedAddonModification'|'K8sResourceNotFound',
'errorMessage': 'string',
'resourceIds': [
'string',
]
},
],
'cancellation': {
'status': 'InProgress'|'Failed'|'Successful',
'reason': '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 at object creation.
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.
SubnetNotFound: We couldn't find one of the subnets associated with the cluster.
SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster doesn't have any available IP addresses.
AccessDenied: You don't have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
VpcIdNotFound: We couldn't find the VPC associated with the cluster.
errorMessage (string) --
A more complete description of the error.
resourceIds (list) --
An optional field that contains the resource IDs associated with the error.
(string) --
cancellation (dict) --
The latest cancellation information for the update. This field is present only if any cancellation is attempted for the update.
status (string) --
The current status of the cancellation. Valid values are InProgress, Failed, and Successful.
reason (string) --
A message providing additional details about the cancellation, such as the reason for the cancellation or failure details.