aws_eks
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane.
Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.Summary
Functions
-
associate_encryption_config(Client, ClusterName, Input)
Associate encryption configuration to an existing cluster.
- associate_encryption_config(Client, ClusterName, Input0, Options0)
-
associate_identity_provider_config(Client, ClusterName, Input)
Associate an identity provider configuration to a cluster.
- associate_identity_provider_config(Client, ClusterName, Input0, Options0)
-
create_addon(Client, ClusterName, Input)
Creates an Amazon EKS add-on.
- create_addon(Client, ClusterName, Input0, Options0)
-
create_cluster(Client, Input)
Creates an Amazon EKS control plane.
- create_cluster(Client, Input0, Options0)
-
create_fargate_profile(Client, ClusterName, Input)
Creates an AWS Fargate profile for your Amazon EKS cluster.
- create_fargate_profile(Client, ClusterName, Input0, Options0)
-
create_nodegroup(Client, ClusterName, Input)
Creates a managed node group for an Amazon EKS cluster.
- create_nodegroup(Client, ClusterName, Input0, Options0)
-
delete_addon(Client, AddonName, ClusterName, Input)
Delete an Amazon EKS add-on.
- delete_addon(Client, AddonName, ClusterName, Input0, Options0)
-
delete_cluster(Client, Name, Input)
Deletes the Amazon EKS cluster control plane.
- delete_cluster(Client, Name, Input0, Options0)
-
delete_fargate_profile(Client, ClusterName, FargateProfileName, Input)
Deletes an AWS Fargate profile.
- delete_fargate_profile(Client, ClusterName, FargateProfileName, Input0, Options0)
-
delete_nodegroup(Client, ClusterName, NodegroupName, Input)
Deletes an Amazon EKS node group for a cluster.
- delete_nodegroup(Client, ClusterName, NodegroupName, Input0, Options0)
-
describe_addon(Client, AddonName, ClusterName)
Describes an Amazon EKS add-on.
- describe_addon(Client, AddonName, ClusterName, QueryMap, HeadersMap)
- describe_addon(Client, AddonName, ClusterName, QueryMap, HeadersMap, Options0)
-
describe_addon_versions(Client)
Describes the Kubernetes versions that the add-on can be used with.
- describe_addon_versions(Client, QueryMap, HeadersMap)
- describe_addon_versions(Client, QueryMap, HeadersMap, Options0)
-
describe_cluster(Client, Name)
Returns descriptive information about an Amazon EKS cluster.
- describe_cluster(Client, Name, QueryMap, HeadersMap)
- describe_cluster(Client, Name, QueryMap, HeadersMap, Options0)
-
describe_fargate_profile(Client, ClusterName, FargateProfileName)
Returns descriptive information about an AWS Fargate profile.
- describe_fargate_profile(Client, ClusterName, FargateProfileName, QueryMap, HeadersMap)
- describe_fargate_profile(Client, ClusterName, FargateProfileName, QueryMap, HeadersMap, Options0)
-
describe_identity_provider_config(Client, ClusterName, Input)
Returns descriptive information about an identity provider configuration.
- describe_identity_provider_config(Client, ClusterName, Input0, Options0)
-
describe_nodegroup(Client, ClusterName, NodegroupName)
Returns descriptive information about an Amazon EKS node group.
- describe_nodegroup(Client, ClusterName, NodegroupName, QueryMap, HeadersMap)
- describe_nodegroup(Client, ClusterName, NodegroupName, QueryMap, HeadersMap, Options0)
-
describe_update(Client, Name, UpdateId)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
- describe_update(Client, Name, UpdateId, QueryMap, HeadersMap)
- describe_update(Client, Name, UpdateId, QueryMap, HeadersMap, Options0)
-
disassociate_identity_provider_config(Client, ClusterName, Input)
Disassociates an identity provider configuration from a cluster.
- disassociate_identity_provider_config(Client, ClusterName, Input0, Options0)
-
list_addons(Client, ClusterName)
Lists the available add-ons.
- list_addons(Client, ClusterName, QueryMap, HeadersMap)
- list_addons(Client, ClusterName, QueryMap, HeadersMap, Options0)
-
list_clusters(Client)
Lists the Amazon EKS clusters in your AWS account in the specified Region.
- list_clusters(Client, QueryMap, HeadersMap)
- list_clusters(Client, QueryMap, HeadersMap, Options0)
-
list_fargate_profiles(Client, ClusterName)
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
- list_fargate_profiles(Client, ClusterName, QueryMap, HeadersMap)
- list_fargate_profiles(Client, ClusterName, QueryMap, HeadersMap, Options0)
-
list_identity_provider_configs(Client, ClusterName)
A list of identity provider configurations.
- list_identity_provider_configs(Client, ClusterName, QueryMap, HeadersMap)
- list_identity_provider_configs(Client, ClusterName, QueryMap, HeadersMap, Options0)
-
list_nodegroups(Client, ClusterName)
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region.
- list_nodegroups(Client, ClusterName, QueryMap, HeadersMap)
- list_nodegroups(Client, ClusterName, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
List the tags for an Amazon EKS resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
list_updates(Client, Name)
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
- list_updates(Client, Name, QueryMap, HeadersMap)
- list_updates(Client, Name, QueryMap, HeadersMap, Options0)
-
tag_resource(Client, ResourceArn, Input)
Associates the specified tags to a resource with the specified
resourceArn
. - tag_resource(Client, ResourceArn, Input0, Options0)
-
untag_resource(Client, ResourceArn, Input)
Deletes specified tags from a resource.
- untag_resource(Client, ResourceArn, Input0, Options0)
-
update_addon(Client, AddonName, ClusterName, Input)
Updates an Amazon EKS add-on.
- update_addon(Client, AddonName, ClusterName, Input0, Options0)
-
update_cluster_config(Client, Name, Input)
Updates an Amazon EKS cluster configuration.
- update_cluster_config(Client, Name, Input0, Options0)
-
update_cluster_version(Client, Name, Input)
Updates an Amazon EKS cluster to the specified Kubernetes version.
- update_cluster_version(Client, Name, Input0, Options0)
-
update_nodegroup_config(Client, ClusterName, NodegroupName, Input)
Updates an Amazon EKS managed node group configuration.
- update_nodegroup_config(Client, ClusterName, NodegroupName, Input0, Options0)
-
update_nodegroup_version(Client, ClusterName, NodegroupName, Input)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
- update_nodegroup_version(Client, ClusterName, NodegroupName, Input0, Options0)
Functions
associate_encryption_config(Client, ClusterName, Input)
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 EKS clusters.associate_encryption_config(Client, ClusterName, Input0, Options0)
associate_identity_provider_config(Client, ClusterName, Input)
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 Kubernetesroles
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.
associate_identity_provider_config(Client, ClusterName, Input0, Options0)
create_addon(Client, ClusterName, Input)
Creates an Amazon EKS add-on.
Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS clusters running version 1.18 with platform versioneks.3
or later because add-ons rely on the
Server-side Apply Kubernetes feature, which is only available in
Kubernetes 1.18 and later.
create_addon(Client, ClusterName, Input0, Options0)
create_cluster(Client, Input)
Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run
the Kubernetes software, such as etcd
and the API server. The control
plane runs in an account managed by AWS, and the Kubernetes API is exposed
via the Amazon EKS API server endpoint. Each Amazon EKS cluster control
plane is single-tenant and unique and runs on its own set of Amazon EC2
instances.
The cluster control plane is provisioned across multiple Availability
Zones and fronted by an Elastic Load Balancing Network Load Balancer.
Amazon EKS also provisions elastic network interfaces in your VPC subnets
to provide connectivity from the control plane instances to the nodes (for
example, to support kubectl exec
, logs
, and proxy
data flows).
Amazon EKS nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.
Cluster creation typically takes several minutes. 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.create_cluster(Client, Input0, Options0)
create_fargate_profile(Client, ClusterName, Input)
Creates an AWS Fargate profile for your Amazon EKS cluster.
You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role
to use with the pods that are scheduled with the profile. This role is
added to the cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet
that is running on the Fargate
infrastructure can register with your Amazon EKS cluster so that it can
appear in your cluster as a node. The pod execution role also provides IAM
permissions to the Fargate infrastructure to allow read access to Amazon
ECR image repositories. For more information, see Pod Execution Role in
the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you
must wait for that Fargate profile to finish deleting before you can
create any other profiles in that cluster.
create_fargate_profile(Client, ClusterName, Input0, Options0)
create_nodegroup(Client, ClusterName, Input)
Creates a managed node group for an Amazon EKS cluster.
You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support.
An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide.create_nodegroup(Client, ClusterName, Input0, Options0)
delete_addon(Client, AddonName, ClusterName, Input)
Delete an Amazon EKS add-on.
When you remove the add-on, it will also be deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.delete_addon(Client, AddonName, ClusterName, Input0, Options0)
delete_cluster(Client, Name, Input)
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, seeDeleteNodegroup
and DeleteFargateProfile
.
delete_cluster(Client, Name, Input0, Options0)
delete_fargate_profile(Client, ClusterName, FargateProfileName, Input)
Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in theDELETING
status at a
time. You must wait for a Fargate profile to finish deleting before you
can delete any other profiles in that cluster.
delete_fargate_profile(Client, ClusterName, FargateProfileName, Input0, Options0)
delete_nodegroup(Client, ClusterName, NodegroupName, Input)
Deletes an Amazon EKS node group for a cluster.
delete_nodegroup(Client, ClusterName, NodegroupName, Input0, Options0)
describe_addon(Client, AddonName, ClusterName)
Describes an Amazon EKS add-on.
describe_addon(Client, AddonName, ClusterName, QueryMap, HeadersMap)
describe_addon(Client, AddonName, ClusterName, QueryMap, HeadersMap, Options0)
describe_addon_versions(Client)
Describes the Kubernetes versions that the add-on can be used with.
describe_addon_versions(Client, QueryMap, HeadersMap)
describe_addon_versions(Client, QueryMap, HeadersMap, Options0)
describe_cluster(Client, Name)
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.
ACTIVE
state.
describe_cluster(Client, Name, QueryMap, HeadersMap)
describe_cluster(Client, Name, QueryMap, HeadersMap, Options0)
describe_fargate_profile(Client, ClusterName, FargateProfileName)
Returns descriptive information about an AWS Fargate profile.
describe_fargate_profile(Client, ClusterName, FargateProfileName, QueryMap, HeadersMap)
describe_fargate_profile(Client, ClusterName, FargateProfileName, QueryMap, HeadersMap, Options0)
describe_identity_provider_config(Client, ClusterName, Input)
Returns descriptive information about an identity provider configuration.
describe_identity_provider_config(Client, ClusterName, Input0, Options0)
describe_nodegroup(Client, ClusterName, NodegroupName)
Returns descriptive information about an Amazon EKS node group.
describe_nodegroup(Client, ClusterName, NodegroupName, QueryMap, HeadersMap)
describe_nodegroup(Client, ClusterName, NodegroupName, QueryMap, HeadersMap, Options0)
describe_update(Client, Name, UpdateId)
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.
When the status of the update isSucceeded
, the update is complete. If
an update fails, the status is Failed
, and an error detail explains the
reason for the failure.
describe_update(Client, Name, UpdateId, QueryMap, HeadersMap)
describe_update(Client, Name, UpdateId, QueryMap, HeadersMap, Options0)
disassociate_identity_provider_config(Client, ClusterName, Input)
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 AWS IAM users.disassociate_identity_provider_config(Client, ClusterName, Input0, Options0)
list_addons(Client, ClusterName)
Lists the available add-ons.
list_addons(Client, ClusterName, QueryMap, HeadersMap)
list_addons(Client, ClusterName, QueryMap, HeadersMap, Options0)
list_clusters(Client)
Lists the Amazon EKS clusters in your AWS account in the specified Region.
list_clusters(Client, QueryMap, HeadersMap)
list_clusters(Client, QueryMap, HeadersMap, Options0)
list_fargate_profiles(Client, ClusterName)
Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
list_fargate_profiles(Client, ClusterName, QueryMap, HeadersMap)
list_fargate_profiles(Client, ClusterName, QueryMap, HeadersMap, Options0)
list_identity_provider_configs(Client, ClusterName)
A list of identity provider configurations.
list_identity_provider_configs(Client, ClusterName, QueryMap, HeadersMap)
list_identity_provider_configs(Client, ClusterName, QueryMap, HeadersMap, Options0)
list_nodegroups(Client, ClusterName)
Lists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region.
Self-managed node groups are not listed.list_nodegroups(Client, ClusterName, QueryMap, HeadersMap)
list_nodegroups(Client, ClusterName, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
List the tags for an Amazon EKS resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
list_updates(Client, Name)
Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region.
list_updates(Client, Name, QueryMap, HeadersMap)
list_updates(Client, Name, QueryMap, HeadersMap, Options0)
tag_resource(Client, ResourceArn, Input)
Associates the specified tags to a resource with the specified
resourceArn
.
tag_resource(Client, ResourceArn, Input0, Options0)
untag_resource(Client, ResourceArn, Input)
Deletes specified tags from a resource.
untag_resource(Client, ResourceArn, Input0, Options0)
update_addon(Client, AddonName, ClusterName, Input)
Updates an Amazon EKS add-on.
update_addon(Client, AddonName, ClusterName, Input0, Options0)
update_cluster_config(Client, Name, Input)
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 .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.
You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
At this time, you can not update the subnets or security group IDs for an existing cluster.
Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves toUPDATING
(this
status transition is eventually consistent). When the update is complete
(either Failed
or Successful
), the cluster status moves to Active
.
update_cluster_config(Client, Name, Input0, Options0)
update_cluster_version(Client, Name, Input)
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
.
update_cluster_version(Client, Name, Input0, Options0)
update_nodegroup_config(Client, ClusterName, NodegroupName, Input)
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 theDescribeUpdate
API operation. Currently you
can update the Kubernetes labels for a node group or the scaling
configuration.
update_nodegroup_config(Client, ClusterName, NodegroupName, Input0, Options0)
update_nodegroup_version(Client, ClusterName, NodegroupName, Input)
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling action or update, the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully and will fail if it is unable to do so. You canforce
the update if Amazon EKS is unable to drain the nodes as a result
of a pod disruption budget issue.