2023/10/24 - Amazon Elastic Kubernetes Service - 14 updated api methods
Changes Added support for Cluster Subnet and Security Group mutability.
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Associate encryption configuration to an existing cluster.
You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.
See also: AWS API Documentation
Request Syntax
client.associate_encryption_config(
clusterName='string',
encryptionConfig=[
{
'resources': [
'string',
],
'provider': {
'keyArn': 'string'
}
},
],
clientRequestToken='string'
)
string
[REQUIRED]
The name of the cluster that you are associating with encryption configuration.
list
[REQUIRED]
The configuration you are using for encryption.
(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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 .
string
The client request token you are using with the encryption configuration.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Associate an identity provider configuration to a cluster.
If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes roles and clusterroles to assign permissions to the roles, and then bind the roles to the identities using Kubernetes rolebindings and clusterrolebindings . For more information see Using RBAC Authorization in the Kubernetes documentation.
See also: AWS API Documentation
Request Syntax
client.associate_identity_provider_config(
clusterName='string',
oidc={
'identityProviderConfigName': 'string',
'issuerUrl': 'string',
'clientId': 'string',
'usernameClaim': 'string',
'usernamePrefix': 'string',
'groupsClaim': 'string',
'groupsPrefix': 'string',
'requiredClaims': {
'string': 'string'
}
},
tags={
'string': 'string'
},
clientRequestToken='string'
)
string
[REQUIRED]
The name of the cluster to associate the configuration to.
dict
[REQUIRED]
An object representing an OpenID Connect (OIDC) identity provider configuration.
identityProviderConfigName (string) -- [REQUIRED]
The name of the OIDC provider configuration.
issuerUrl (string) -- [REQUIRED]
The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com . This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.
clientId (string) -- [REQUIRED]
This is also known as audience . The ID for the client application that makes authentication requests to the OpenID identity provider.
usernameClaim (string) --
The JSON Web Token (JWT) claim to use as the username. The default is sub , which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name , depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.
usernamePrefix (string) --
The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email , the prefix defaults to issuerurl# . You can use the value - to disable all prefixing.
groupsClaim (string) --
The JWT claim that the provider uses to return your groups.
groupsPrefix (string) --
The prefix that is prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra .
requiredClaims (dict) --
The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide .
(string) --
(string) --
dict
The metadata to apply to the configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
(string) --
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
tags (dict) --
The tags for the resource.
(string) --
(string) --
{'cluster': {'health': {'issues': {'code': {'Ec2SecurityGroupNotFound',
'Ec2ServiceNotSubscribed',
'Ec2SubnetNotFound',
'IamRoleNotFound',
'InsufficientFreeAddresses',
'KmsGrantRevoked',
'KmsKeyDisabled',
'KmsKeyMarkedForDeletion',
'KmsKeyNotFound',
'Other',
'StsRegionalEndpointDisabled',
'UnsupportedVersion',
'VpcNotFound'}}}}}
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.
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 Managing Cluster Authentication 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',
]
},
kubernetesNetworkConfig={
'serviceIpv4Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
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'
}
}
)
string
[REQUIRED]
The unique name to give to your cluster.
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.
Note
The default version might not be the latest version available.
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. For more information, see Amazon EKS cluster endpoint access control 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
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.
Warning
You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.
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.
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 .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes that your cluster will have. For more information, see Capacity considerations in the Amazon EKS User Guide .
The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS.
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.
dict
Response Syntax
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
'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'
},
'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'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your new cluster.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to 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) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes pod and service 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 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 add-on and specified ipv6 when you created the cluster.
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.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
issues (list) --
An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
(dict) --
An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
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 used for the control plane. 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.
{'cluster': {'health': {'issues': {'code': {'Ec2SecurityGroupNotFound',
'Ec2ServiceNotSubscribed',
'Ec2SubnetNotFound',
'IamRoleNotFound',
'InsufficientFreeAddresses',
'KmsGrantRevoked',
'KmsKeyDisabled',
'KmsKeyMarkedForDeletion',
'KmsKeyNotFound',
'Other',
'StsRegionalEndpointDisabled',
'UnsupportedVersion',
'VpcNotFound'}}}}}
Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide .
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
See also: AWS API Documentation
Request Syntax
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',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
'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'
},
'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'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of the cluster to delete.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to 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) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes pod and service 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 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 add-on and specified ipv6 when you created the cluster.
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.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
issues (list) --
An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
(dict) --
An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
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 used for the control plane. 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.
{'cluster': {'health': {'issues': {'code': {'Ec2SecurityGroupNotFound',
'Ec2ServiceNotSubscribed',
'Ec2SubnetNotFound',
'IamRoleNotFound',
'InsufficientFreeAddresses',
'KmsGrantRevoked',
'KmsKeyDisabled',
'KmsKeyMarkedForDeletion',
'KmsKeyNotFound',
'Other',
'StsRegionalEndpointDisabled',
'UnsupportedVersion',
'VpcNotFound'}}}}}
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
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',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
'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'
},
'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'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
An object representing an Amazon EKS cluster.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to 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) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes pod and service 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 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 add-on and specified ipv6 when you created the cluster.
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.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
issues (list) --
An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
(dict) --
An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
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 used for the control plane. 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.
{'cluster': {'health': {'issues': {'code': {'Ec2SecurityGroupNotFound',
'Ec2ServiceNotSubscribed',
'Ec2SubnetNotFound',
'IamRoleNotFound',
'InsufficientFreeAddresses',
'KmsGrantRevoked',
'KmsKeyDisabled',
'KmsKeyMarkedForDeletion',
'KmsKeyNotFound',
'Other',
'StsRegionalEndpointDisabled',
'UnsupportedVersion',
'VpcNotFound'}}}}}
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.
Note
The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.
See also: AWS API Documentation
Request Syntax
client.describe_cluster(
name='string'
)
string
[REQUIRED]
The name of the cluster to describe.
dict
Response Syntax
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
'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'
},
'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'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
The full description of your specified cluster.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to 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) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes pod and service 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 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 add-on and specified ipv6 when you created the cluster.
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.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
issues (list) --
An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
(dict) --
An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
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 used for the control plane. 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.
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.
When the status of the update is Succeeded , the update is complete. If an update fails, the status is Failed , and an error detail explains the reason for the failure.
See also: AWS API Documentation
Request Syntax
client.describe_update(
name='string',
updateId='string',
nodegroupName='string',
addonName='string'
)
string
[REQUIRED]
The name of the Amazon EKS cluster associated with the update.
string
[REQUIRED]
The ID of the update to describe.
string
The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.
string
The name of the add-on. The name must match one of the names returned by ListAddons. This parameter is required if the update is an add-on update.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
The full description of the specified update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with Amazon Web Services IAM users.
See also: AWS API Documentation
Request Syntax
client.disassociate_identity_provider_config(
clusterName='string',
identityProviderConfig={
'type': 'string',
'name': 'string'
},
clientRequestToken='string'
)
string
[REQUIRED]
The name of the cluster to disassociate an identity provider from.
dict
[REQUIRED]
An object representing an identity provider configuration.
type (string) -- [REQUIRED]
The type of the identity provider configuration. The only type available is oidc .
name (string) -- [REQUIRED]
The name of the identity provider configuration.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'cluster': {'health': {'issues': {'code': {'Ec2SecurityGroupNotFound',
'Ec2ServiceNotSubscribed',
'Ec2SubnetNotFound',
'IamRoleNotFound',
'InsufficientFreeAddresses',
'KmsGrantRevoked',
'KmsKeyDisabled',
'KmsKeyMarkedForDeletion',
'KmsKeyNotFound',
'Other',
'StsRegionalEndpointDisabled',
'UnsupportedVersion',
'VpcNotFound'}}}}}
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, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See 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]
Define a unique name for this cluster for your 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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
dict
Response Syntax
{
'cluster': {
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'version': 'string',
'endpoint': 'string',
'roleArn': 'string',
'resourcesVpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'clusterSecurityGroupId': 'string',
'vpcId': 'string',
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
'kubernetesNetworkConfig': {
'serviceIpv4Cidr': 'string',
'serviceIpv6Cidr': 'string',
'ipFamily': 'ipv4'|'ipv6'
},
'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'
},
'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'
}
}
}
}
Response Structure
(dict) --
cluster (dict) --
An object representing an Amazon EKS cluster.
name (string) --
The name of the cluster.
arn (string) --
The Amazon Resource Name (ARN) of the cluster.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the cluster was created.
version (string) --
The Kubernetes server version for the cluster.
endpoint (string) --
The endpoint for your Kubernetes API server.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to 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) --
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
endpointPrivateAccess (boolean) --
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
kubernetesNetworkConfig (dict) --
The Kubernetes network configuration for the cluster.
serviceIpv4Cidr (string) --
The CIDR block that Kubernetes pod and service 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 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 add-on and specified ipv6 when you created the cluster.
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.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
platformVersion (string) --
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
tags (dict) --
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
(string) --
(string) --
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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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 local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
issues (list) --
An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.
(dict) --
An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost. You can't use this API with an Amazon EKS cluster on the Amazon Web Services cloud.
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 used for the control plane. 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.
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Updates an Amazon EKS add-on.
See also: AWS API Documentation
Request Syntax
client.update_addon(
clusterName='string',
addonName='string',
addonVersion='string',
serviceAccountRoleArn='string',
resolveConflicts='OVERWRITE'|'NONE'|'PRESERVE',
clientRequestToken='string',
configurationValues='string'
)
string
[REQUIRED]
The name of the cluster.
string
[REQUIRED]
The name of the add-on. The name must match one of the names returned by ListAddons.
string
The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions.
string
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide .
Note
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide .
string
How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:
None – Amazon EKS doesn't change the value. The update might fail.
Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.
Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The set of configuration values for the add-on that's created. The values that you provide are validated against the schema in DescribeAddonConfiguration.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
Warning
You can't update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful ), the cluster status moves to Active .
See also: AWS API Documentation
Request Syntax
client.update_cluster_config(
name='string',
resourcesVpcConfig={
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'endpointPublicAccess': True|False,
'endpointPrivateAccess': True|False,
'publicAccessCidrs': [
'string',
]
},
logging={
'clusterLogging': [
{
'types': [
'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
],
'enabled': True|False
},
]
},
clientRequestToken='string'
)
string
[REQUIRED]
The name of the Amazon EKS cluster to update.
dict
An object representing the VPC configuration to use for an Amazon EKS cluster.
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. For more information, see Amazon EKS cluster endpoint access control 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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
publicAccessCidrs (list) --
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
(string) --
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 .
Note
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.
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
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful ), the cluster status moves to Active .
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
See also: AWS API Documentation
Request Syntax
client.update_cluster_version(
name='string',
version='string',
clientRequestToken='string'
)
string
[REQUIRED]
The name of the Amazon EKS cluster to update.
string
[REQUIRED]
The desired Kubernetes version following a successful update.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
The full description of the specified update
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.
See also: AWS API Documentation
Request Syntax
client.update_nodegroup_config(
clusterName='string',
nodegroupName='string',
labels={
'addOrUpdateLabels': {
'string': 'string'
},
'removeLabels': [
'string',
]
},
taints={
'addOrUpdateTaints': [
{
'key': 'string',
'value': 'string',
'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE'
},
],
'removeTaints': [
{
'key': 'string',
'value': 'string',
'effect': 'NO_SCHEDULE'|'NO_EXECUTE'|'PREFER_NO_SCHEDULE'
},
]
},
scalingConfig={
'minSize': 123,
'maxSize': 123,
'desiredSize': 123
},
updateConfig={
'maxUnavailable': 123,
'maxUnavailablePercentage': 123
},
clientRequestToken='string'
)
string
[REQUIRED]
The name of the Amazon EKS cluster that the managed node group resides in.
string
[REQUIRED]
The name of the managed node group to update.
dict
The Kubernetes labels to be applied to the nodes in the node group after the update.
addOrUpdateLabels (dict) --
Kubernetes labels to be added or updated.
(string) --
(string) --
removeLabels (list) --
Kubernetes labels to be removed.
(string) --
dict
The Kubernetes taints to be applied to the nodes in the node group after the update. For more information, see Node taints on managed node groups.
addOrUpdateTaints (list) --
Kubernetes taints to be added or updated.
(dict) --
A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups.
key (string) --
The key of the taint.
value (string) --
The value of the taint.
effect (string) --
The effect of the taint.
removeTaints (list) --
Kubernetes taints to remove.
(dict) --
A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups.
key (string) --
The key of the taint.
value (string) --
The value of the taint.
effect (string) --
The effect of the taint.
dict
The scaling configuration details for the Auto Scaling group after the update.
minSize (integer) --
The minimum number of nodes that the managed node group can scale in to.
maxSize (integer) --
The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
desiredSize (integer) --
The current number of nodes that the managed node group should maintain.
Warning
If you use Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.
Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.
This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler (but can be out-of-date for short periods of time). Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.
dict
The node group update configuration.
maxUnavailable (integer) --
The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
maxUnavailablePercentage (integer) --
The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --
{'update': {'params': {'type': {'ConfigurationValues',
'SecurityGroups',
'Subnets'}},
'type': {'VpcConfigUpdate'}}}
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide . For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide .
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You can force the update if Amazon EKS is unable to drain the nodes as a result of a pod disruption budget issue.
See also: AWS API Documentation
Request Syntax
client.update_nodegroup_version(
clusterName='string',
nodegroupName='string',
version='string',
releaseVersion='string',
launchTemplate={
'name': 'string',
'version': 'string',
'id': 'string'
},
force=True|False,
clientRequestToken='string'
)
string
[REQUIRED]
The name of the Amazon EKS cluster that is associated with the managed node group to update.
string
[REQUIRED]
The name of the managed node group to update.
string
The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify version , or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .
string
The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide . Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide .
If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify releaseVersion , or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .
dict
An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.
name (string) --
The name of the launch template.
You must specify either the launch template name or the launch template ID in the request, but not both.
version (string) --
The version number of the launch template to use. If no version is specified, then the template's default version is used.
id (string) --
The ID of the launch template.
You must specify either the launch template ID or the launch template name in the request, but not both.
boolean
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'update': {
'id': 'string',
'status': 'InProgress'|'Failed'|'Cancelled'|'Successful',
'type': 'VersionUpdate'|'EndpointAccessUpdate'|'LoggingUpdate'|'ConfigUpdate'|'AssociateIdentityProviderConfig'|'DisassociateIdentityProviderConfig'|'AssociateEncryptionConfig'|'AddonUpdate'|'VpcConfigUpdate',
'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'|'ConfigurationValues'|'SecurityGroups'|'Subnets',
'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',
]
},
]
}
}
Response Structure
(dict) --
update (dict) --
An object representing an asynchronous update.
id (string) --
A UUID that is used to track the update.
status (string) --
The current status of the update.
type (string) --
The type of the update.
params (list) --
A key-value map that contains the parameters associated with the update.
(dict) --
An object representing the details of an update request.
type (string) --
The keys associated with an update request.
value (string) --
The value of the keys submitted as part of an update request.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the update was created.
errors (list) --
Any errors associated with a Failed update.
(dict) --
An object representing an error when an asynchronous operation fails.
errorCode (string) --
A brief description of the error.
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 free 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) --