EksClient

interface EksClient : SdkClient

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 setup 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.

Properties

Link copied to clipboard
abstract override val config: EksClient.Config

EksClient's configuration

Functions

Link copied to clipboard

Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.

Link copied to clipboard

Associates an encryption configuration to an existing cluster.

Link copied to clipboard

Associates an identity provider configuration to a cluster.

Link copied to clipboard

Creates an access entry.

Link copied to clipboard
abstract suspend fun createAddon(input: CreateAddonRequest): CreateAddonResponse

Creates an Amazon EKS add-on.

Link copied to clipboard

Creates an Amazon EKS control plane.

Link copied to clipboard

Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.

Link copied to clipboard

Creates 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.

Link copied to clipboard

Creates a managed node group for an Amazon EKS cluster.

Link copied to clipboard

Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to Pods and the credentials are rotated automatically.

Link copied to clipboard

Deletes an access entry.

Link copied to clipboard
abstract suspend fun deleteAddon(input: DeleteAddonRequest): DeleteAddonResponse

Deletes an Amazon EKS add-on.

Link copied to clipboard

Deletes an Amazon EKS cluster control plane.

Link copied to clipboard

Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.

Link copied to clipboard

Deletes an Fargate profile.

Link copied to clipboard

Deletes a managed node group.

Link copied to clipboard

Deletes a EKS Pod Identity association.

Link copied to clipboard

Deregisters a connected cluster to remove it from the Amazon EKS control plane.

Link copied to clipboard

Describes an access entry.

Link copied to clipboard

Describes an Amazon EKS add-on.

Link copied to clipboard

Returns configuration options.

Link copied to clipboard
abstract suspend fun describeAddonVersions(input: DescribeAddonVersionsRequest = DescribeAddonVersionsRequest { }): DescribeAddonVersionsResponse

Describes the versions for an add-on.

Link copied to clipboard

Describes an Amazon EKS cluster.

Link copied to clipboard
abstract suspend fun describeClusterVersions(input: DescribeClusterVersionsRequest = DescribeClusterVersionsRequest { }): DescribeClusterVersionsResponse

Lists available Kubernetes versions for Amazon EKS clusters.

Link copied to clipboard

Returns descriptive information about a subscription.

Link copied to clipboard

Describes an Fargate profile.

Link copied to clipboard

Describes an identity provider configuration.

Link copied to clipboard

Returns details about an insight that you specify using its ID.

Link copied to clipboard

Describes a managed node group.

Link copied to clipboard

Returns descriptive information about an EKS Pod Identity association.

Link copied to clipboard

Describes an update to an Amazon EKS resource.

Link copied to clipboard

Disassociates an access policy from an access entry.

Link copied to clipboard

Disassociates an identity provider configuration from a cluster.

Link copied to clipboard

Lists the access entries for your cluster.

Link copied to clipboard
abstract suspend fun listAccessPolicies(input: ListAccessPoliciesRequest = ListAccessPoliciesRequest { }): ListAccessPoliciesResponse

Lists the available access policies.

Link copied to clipboard
abstract suspend fun listAddons(input: ListAddonsRequest): ListAddonsResponse

Lists the installed add-ons.

Link copied to clipboard

Lists the access policies associated with an access entry.

Link copied to clipboard
abstract suspend fun listClusters(input: ListClustersRequest = ListClustersRequest { }): ListClustersResponse

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.

Link copied to clipboard
abstract suspend fun listEksAnywhereSubscriptions(input: ListEksAnywhereSubscriptionsRequest = ListEksAnywhereSubscriptionsRequest { }): ListEksAnywhereSubscriptionsResponse

Displays the full description of the subscription.

Link copied to clipboard

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.

Link copied to clipboard

Lists the identity provider configurations for your cluster.

Link copied to clipboard

Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status.

Link copied to clipboard

Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.

Link copied to clipboard

List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.

Link copied to clipboard

List the tags for an Amazon EKS resource.

Link copied to clipboard
abstract suspend fun listUpdates(input: ListUpdatesRequest): ListUpdatesResponse

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

Link copied to clipboard

Connects a Kubernetes cluster to the Amazon EKS control plane.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.

Link copied to clipboard

Deletes specified tags from an Amazon EKS resource.

Link copied to clipboard

Updates an access entry.

Link copied to clipboard
abstract suspend fun updateAddon(input: UpdateAddonRequest): UpdateAddonResponse

Updates an Amazon EKS add-on.

Link copied to clipboard

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate.

Link copied to clipboard

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.

Link copied to clipboard

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

Link copied to clipboard

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. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration.

Link copied to clipboard

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

Link copied to clipboard

Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.

Inherited functions

Link copied to clipboard

Associates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.

Link copied to clipboard

Associates an encryption configuration to an existing cluster.

Link copied to clipboard

Associates an identity provider configuration to a cluster.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates an access entry.

Link copied to clipboard
inline suspend fun EksClient.createAddon(crossinline block: CreateAddonRequest.Builder.() -> Unit): CreateAddonResponse

Creates an Amazon EKS add-on.

Link copied to clipboard
inline suspend fun EksClient.createCluster(crossinline block: CreateClusterRequest.Builder.() -> Unit): CreateClusterResponse

Creates an Amazon EKS control plane.

Link copied to clipboard

Creates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.

Link copied to clipboard

Creates 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.

Link copied to clipboard

Creates a managed node group for an Amazon EKS cluster.

Link copied to clipboard

Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to Pods and the credentials are rotated automatically.

Link copied to clipboard

Deletes an access entry.

Link copied to clipboard
inline suspend fun EksClient.deleteAddon(crossinline block: DeleteAddonRequest.Builder.() -> Unit): DeleteAddonResponse

Deletes an Amazon EKS add-on.

Link copied to clipboard
inline suspend fun EksClient.deleteCluster(crossinline block: DeleteClusterRequest.Builder.() -> Unit): DeleteClusterResponse

Deletes an Amazon EKS cluster control plane.

Link copied to clipboard

Deletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.

Link copied to clipboard

Deletes an Fargate profile.

Link copied to clipboard

Deletes a managed node group.

Link copied to clipboard

Deletes a EKS Pod Identity association.

Link copied to clipboard

Deregisters a connected cluster to remove it from the Amazon EKS control plane.

Link copied to clipboard

Describes an access entry.

Link copied to clipboard
inline suspend fun EksClient.describeAddon(crossinline block: DescribeAddonRequest.Builder.() -> Unit): DescribeAddonResponse

Describes an Amazon EKS add-on.

Link copied to clipboard

Returns configuration options.

Link copied to clipboard

Describes the versions for an add-on.

Link copied to clipboard

Describes an Amazon EKS cluster.

Link copied to clipboard

Lists available Kubernetes versions for Amazon EKS clusters.

Link copied to clipboard

Returns descriptive information about a subscription.

Link copied to clipboard

Describes an Fargate profile.

Link copied to clipboard

Describes an identity provider configuration.

Link copied to clipboard

Returns details about an insight that you specify using its ID.

Link copied to clipboard

Describes a managed node group.

Link copied to clipboard

Returns descriptive information about an EKS Pod Identity association.

Link copied to clipboard

Describes an update to an Amazon EKS resource.

Link copied to clipboard

Disassociates an access policy from an access entry.

Link copied to clipboard

Disassociates an identity provider configuration from a cluster.

Link copied to clipboard

Lists the access entries for your cluster.

Link copied to clipboard

Lists the available access policies.

Link copied to clipboard
inline suspend fun EksClient.listAddons(crossinline block: ListAddonsRequest.Builder.() -> Unit): ListAddonsResponse

Lists the installed add-ons.

Link copied to clipboard

Lists the access policies associated with an access entry.

Link copied to clipboard
inline suspend fun EksClient.listClusters(crossinline block: ListClustersRequest.Builder.() -> Unit): ListClustersResponse

Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.

Link copied to clipboard
Link copied to clipboard

Displays the full description of the subscription.

Link copied to clipboard

Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.

Link copied to clipboard

Lists the identity provider configurations for your cluster.

Link copied to clipboard
inline suspend fun EksClient.listInsights(crossinline block: ListInsightsRequest.Builder.() -> Unit): ListInsightsResponse

Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status.

Link copied to clipboard

Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.

Link copied to clipboard

List the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.

Link copied to clipboard

List the tags for an Amazon EKS resource.

Link copied to clipboard
inline suspend fun EksClient.listUpdates(crossinline block: ListUpdatesRequest.Builder.() -> Unit): ListUpdatesResponse

Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.

Link copied to clipboard

Connects a Kubernetes cluster to the Amazon EKS control plane.

Link copied to clipboard
inline suspend fun EksClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nodes associated with the cluster.

Link copied to clipboard
inline suspend fun EksClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes specified tags from an Amazon EKS resource.

Link copied to clipboard

Updates an access entry.

Link copied to clipboard
inline suspend fun EksClient.updateAddon(crossinline block: UpdateAddonRequest.Builder.() -> Unit): UpdateAddonResponse

Updates an Amazon EKS add-on.

Link copied to clipboard

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with DescribeUpdate.

Link copied to clipboard

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.

Link copied to clipboard

Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.

Link copied to clipboard

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. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration.

Link copied to clipboard

Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.

Link copied to clipboard

Updates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.