View Source AWS.EKS (aws-elixir v0.13.3)
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on Amazon Web Services 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.
Link to this section Summary
Functions
Associate encryption configuration to an existing cluster.
Associate an identity provider configuration to a cluster.
Creates an Amazon EKS add-on.
Creates an Amazon EKS control plane.
Creates an Fargate profile for your Amazon EKS cluster.
Creates a managed node group for an Amazon EKS cluster.
Delete an Amazon EKS add-on.
Deletes the Amazon EKS cluster control plane.
Deletes an Fargate profile.
Deletes an Amazon EKS node group for a cluster.
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
Describes an Amazon EKS add-on.
Returns configuration options.
Describes the versions for an add-on.
Returns descriptive information about an Amazon EKS cluster.
Returns descriptive information about an Fargate profile.
Returns descriptive information about an identity provider configuration.
Returns descriptive information about an Amazon EKS node group.
Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.
Disassociates an identity provider configuration from a cluster.
Lists the available add-ons.
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
A list of identity provider configurations.
Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region.
List the tags for an Amazon EKS resource.
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
Connects a Kubernetes cluster to the Amazon EKS control plane.
Associates the specified tags to a resource with the specified resourceArn
.
Deletes specified tags from a resource.
Updates an Amazon EKS add-on.
Updates an Amazon EKS cluster configuration.
Updates an Amazon EKS cluster to the specified Kubernetes version.
Updates an Amazon EKS managed node group configuration.
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
Link to this section Functions
associate_encryption_config(client, cluster_name, input, options \\ [])
View SourceAssociate 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.
associate_identity_provider_config(client, cluster_name, input, options \\ [])
View SourceAssociate 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.
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. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.
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.
create_fargate_profile(client, cluster_name, input, options \\ [])
View SourceCreates an Fargate profile for your Amazon EKS cluster.
You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role to use
with the pods that are scheduled with the profile. This role is added to the
cluster's Kubernetes Role Based Access Control (RBAC) for
authorization so that the kubelet
that is running on the Fargate
infrastructure can register with your Amazon EKS cluster so that it can appear
in your cluster as a node. The pod execution role also provides IAM permissions
to the Fargate infrastructure to allow read access to Amazon ECR image
repositories. For more information, see Pod Execution Role
in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you must wait
for that Fargate profile to finish deleting before you can create any other
profiles in that cluster.
For more information, see Fargate Profile in the Amazon EKS User Guide.
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 Amazon Web Services for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.
Windows AMI types are only supported for commercial Regions that support Windows Amazon EKS.
delete_addon(client, addon_name, cluster_name, input, options \\ [])
View SourceDelete 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.
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
.
delete_fargate_profile(client, cluster_name, fargate_profile_name, input, options \\ [])
View SourceDeletes an Fargate profile.
When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.
Only one Fargate profile in a cluster can be in the DELETING
status at a time.
You must wait for a Fargate profile to finish deleting before you can delete any
other profiles in that cluster.
delete_nodegroup(client, cluster_name, nodegroup_name, input, options \\ [])
View SourceDeletes an Amazon EKS node group for a cluster.
Deregisters a connected cluster to remove it from the Amazon EKS control plane.
Describes an Amazon EKS add-on.
describe_addon_configuration(client, addon_name, addon_version, options \\ [])
View SourceReturns configuration options.
describe_addon_versions(client, addon_name \\ nil, kubernetes_version \\ nil, max_results \\ nil, next_token \\ nil, owners \\ nil, publishers \\ nil, types \\ nil, options \\ [])
View SourceDescribes the versions for an add-on.
Information such as the Kubernetes versions that you can use the add-on with,
the owner
, publisher
, and the type
of the add-on are returned.
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.
The API server endpoint and certificate authority data aren't available until
the cluster reaches the ACTIVE
state.
describe_fargate_profile(client, cluster_name, fargate_profile_name, options \\ [])
View SourceReturns descriptive information about an Fargate profile.
describe_identity_provider_config(client, cluster_name, input, options \\ [])
View SourceReturns descriptive information about an identity provider configuration.
describe_nodegroup(client, cluster_name, nodegroup_name, options \\ [])
View SourceReturns descriptive information about an Amazon EKS node group.
describe_update(client, name, update_id, addon_name \\ nil, nodegroup_name \\ nil, options \\ [])
View SourceReturns 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.
disassociate_identity_provider_config(client, cluster_name, input, options \\ [])
View SourceDisassociates 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.
list_addons(client, cluster_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the available add-ons.
list_clusters(client, include \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
list_fargate_profiles(client, cluster_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region.
list_identity_provider_configs(client, cluster_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceA list of identity provider configurations.
list_nodegroups(client, cluster_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region.
Self-managed node groups are not listed.
List the tags for an Amazon EKS resource.
list_updates(client, name, addon_name \\ nil, max_results \\ nil, next_token \\ nil, nodegroup_name \\ nil, options \\ [])
View SourceLists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.
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
.
Associates the specified tags to a resource with the specified resourceArn
.
If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and nodes associated with the cluster.
Deletes specified tags from a resource.
update_addon(client, addon_name, cluster_name, input, options \\ [])
View SourceUpdates an Amazon EKS add-on.
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 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 .
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
.
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.
update_nodegroup_config(client, cluster_name, nodegroup_name, input, options \\ [])
View SourceUpdates 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.
update_nodegroup_version(client, cluster_name, nodegroup_name, input, options \\ [])
View SourceUpdates 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.