Package-level declarations

Types

Link copied to clipboard

The access configuration for the cluster.

Link copied to clipboard

You don't have permissions to perform the requested operation. The IAM principal making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management in the IAM User Guide.

Link copied to clipboard

An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the aws-auth``ConfigMap for authentication. For more information about access entries, see Access entries in the Amazon EKS User Guide.

Link copied to clipboard

An access policy includes permissions that allow Amazon EKS to authorize an IAM principal to work with Kubernetes objects on your cluster. The policies are managed by Amazon EKS, but they're not IAM policies. You can't view the permissions in the policies using the API. The permissions for many of the policies are similar to the Kubernetes cluster-admin, admin, edit, and view cluster roles. For more information about these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the policies, see Access policy permissions in the Amazon EKS User Guide.

Link copied to clipboard

The scope of an AccessPolicy that's associated to an AccessEntry.

Link copied to clipboard
sealed class AccessScopeType
Link copied to clipboard
class Addon

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

Link copied to clipboard

The summary information about the Amazon EKS add-on compatibility for the next Kubernetes version for an insight check in the UPGRADE_READINESS category.

Link copied to clipboard

The health of the add-on.

Link copied to clipboard
class AddonInfo

Information about an add-on.

Link copied to clipboard

An issue related to an add-on.

Link copied to clipboard
sealed class AddonIssueCode
Link copied to clipboard

A type of EKS Pod Identity association owned by an Amazon EKS add-on.

Link copied to clipboard

Information about how to configure IAM for an add-on.

Link copied to clipboard
sealed class AddonStatus
Link copied to clipboard

Information about an add-on version.

Link copied to clipboard
sealed class AmiTypes
Link copied to clipboard

An access policy association.

Link copied to clipboard
sealed class AuthenticationMode
Link copied to clipboard

An Auto Scaling group that is associated with an Amazon EKS managed node group.

Link copied to clipboard

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

Link copied to clipboard

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.

Link copied to clipboard
sealed class CapacityTypes
Link copied to clipboard
sealed class Category
Link copied to clipboard

An object representing the certificate-authority-data for your cluster.

Link copied to clipboard

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

Link copied to clipboard

Details about clients using the deprecated resources.

Link copied to clipboard
class Cluster

An object representing an Amazon EKS cluster.

Link copied to clipboard

An object representing the health of your Amazon EKS cluster.

Link copied to clipboard

An issue with your Amazon EKS cluster.

Link copied to clipboard
sealed class ClusterIssueCode
Link copied to clipboard
sealed class ClusterStatus
Link copied to clipboard

Contains details about a specific EKS cluster version.

Link copied to clipboard
Link copied to clipboard

Compatibility information.

Link copied to clipboard

Request to update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.

Link copied to clipboard

Indicates the status of the request to update the compute capability of your EKS Auto Mode cluster.

Link copied to clipboard
sealed class ConfigStatus
Link copied to clipboard
Link copied to clipboard

The configuration sent to a cluster for configuration.

Link copied to clipboard

The full description of your connected cluster.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The access configuration information for the cluster.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The summary information about deprecated resource usage for an insight check in the UPGRADE_READINESS category.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes an update request.

Link copied to clipboard
Link copied to clipboard

An EKS Anywhere subscription authorizing the customer to support for licensed clusters and access to EKS Anywhere Curated Packages.

Link copied to clipboard
Link copied to clipboard

An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.

Link copied to clipboard

Base class for all service related exceptions thrown by the Eks client

Link copied to clipboard

Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the Amazon EKS User Guide.

Link copied to clipboard

The encryption configuration for the cluster.

Link copied to clipboard
sealed class ErrorCode
Link copied to clipboard

An object representing an error when an asynchronous operation fails.

Link copied to clipboard

An object representing an Fargate profile.

Link copied to clipboard

The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

Link copied to clipboard

An issue that is associated with the Fargate profile.

Link copied to clipboard
Link copied to clipboard

An object representing an Fargate profile selector.

Link copied to clipboard
Link copied to clipboard
class Identity

An object representing an identity provider.

Link copied to clipboard

An object representing an identity provider configuration.

Link copied to clipboard

The full description of your identity configuration.

Link copied to clipboard
class Insight

A check that provides recommendations to remedy potential upgrade-impacting issues.

Link copied to clipboard

Summary information that relates to the category of the insight. Currently only returned with certain insights having category UPGRADE_READINESS.

Link copied to clipboard

Returns information about the resource being evaluated.

Link copied to clipboard

The criteria to use for the insights.

Link copied to clipboard

The status of the insight.

Link copied to clipboard
sealed class InsightStatusValue
Link copied to clipboard

The summarized description of the insight.

Link copied to clipboard

The specified parameter is invalid. Review the available parameters for the API request.

Link copied to clipboard

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

Link copied to clipboard

Amazon EKS detected upgrade readiness issues. Call the ListInsights API to view detected upgrade blocking issues. Pass the force flag when updating to override upgrade readiness errors.

Link copied to clipboard
sealed class IpFamily
Link copied to clipboard
class Issue

An object representing an issue with an Amazon EKS resource.

Link copied to clipboard

The Kubernetes network configuration for the cluster.

Link copied to clipboard

The Kubernetes network configuration for the cluster. The response contains a value for serviceIpv6Cidr or serviceIpv4Cidr, but not both.

Link copied to clipboard

An object representing a node group launch template specification. The launch template can't include SubnetId, IamInstanceProfile, RequestSpotInstances, HibernationOptions, or TerminateInstances, or the node group deployment or update will fail. For more information about launch templates, see CreateLaunchTemplate in the Amazon EC2 API Reference. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

Link copied to clipboard
class License

An EKS Anywhere license associated with a subscription.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Logging

An object representing the logging configuration for resources in your cluster.

Link copied to clipboard
class LogSetup

An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

Link copied to clipboard
sealed class LogType
Link copied to clipboard

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

Link copied to clipboard
class Nodegroup

An object representing an Amazon EKS managed node group.

Link copied to clipboard

An object representing the health status of the node group.

Link copied to clipboard
sealed class NodegroupIssueCode
Link copied to clipboard

An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

Link copied to clipboard

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. When creating a node group, you must specify all or none of the properties. When updating a node group, you can specify any or none of the properties.

Link copied to clipboard
sealed class NodegroupStatus
Link copied to clipboard

The node group update configuration. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. You choose the maximum unavailable and the update strategy.

Link copied to clipboard
Link copied to clipboard

The node auto repair configuration for the node group.

Link copied to clipboard

A service resource associated with the request could not be found. Clients should not retry such requests.

Link copied to clipboard
class Oidc

An object representing the OpenID Connect (OIDC) identity provider information for the cluster.

Link copied to clipboard

An object representing the configuration for an OpenID Connect (OIDC) identity provider.

Link copied to clipboard

An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OIDC identity provider in the Amazon EKS User Guide.

Link copied to clipboard

The configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a cluster on an Outpost, review Creating a local cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for Amazon EKS clusters on the Amazon Web Services cloud.

Link copied to clipboard

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This API isn't available for Amazon EKS clusters on the Amazon Web Services cloud.

Link copied to clipboard

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

Link copied to clipboard

The summarized description of the association.

Link copied to clipboard
class Provider

Identifies the Key Management Service (KMS) key used to encrypt the secrets.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

An object representing the remote access configuration for the managed node group.

Link copied to clipboard

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Link copied to clipboard

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Link copied to clipboard

A network CIDR that can contain hybrid nodes.

Link copied to clipboard

A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes.

Link copied to clipboard
sealed class ResolveConflicts
Link copied to clipboard

The specified resource is in use.

Link copied to clipboard

You have encountered a service limit on the specified resource.

Link copied to clipboard

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.

Link copied to clipboard

Required resources (such as service-linked roles) were created and are still propagating. Retry later.

Link copied to clipboard

These errors are usually caused by a server-side issue.

Link copied to clipboard

The service is unavailable. Back off and retry the operation.

Link copied to clipboard

Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.

Link copied to clipboard

Indicates the status of the request to update the block storage capability of your EKS Auto Mode cluster.

Link copied to clipboard
sealed class SupportType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Taint

A property that allows a node to repel a Pod. For more information, see Node taints on managed node groups in the Amazon EKS User Guide.

Link copied to clipboard
sealed class TaintEffect
Link copied to clipboard

The request or operation couldn't be performed because a service is throttling requests.

Link copied to clipboard

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Update

An object representing an asynchronous update.

Link copied to clipboard

The access configuration information for the cluster.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

An object representing a Kubernetes label change for a managed node group.

Link copied to clipboard

An object representing the details of an update request.

Link copied to clipboard
sealed class UpdateParamType
Link copied to clipboard
sealed class UpdateStatus
Link copied to clipboard

An object representing the details of an update to a taints payload. For more information, see Node taints on managed node groups in the Amazon EKS User Guide.

Link copied to clipboard
sealed class UpdateType
Link copied to clipboard

The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is EXTENDED. Use STANDARD to disable extended support.

Link copied to clipboard

This value indicates if extended support is enabled or disabled for the cluster.

Link copied to clipboard
sealed class VersionStatus
Link copied to clipboard

An object representing the VPC configuration to use for an Amazon EKS cluster.

Link copied to clipboard

An object representing an Amazon EKS cluster VPC configuration response.

Link copied to clipboard

The configuration for zonal shift for the cluster.

Link copied to clipboard

The status of zonal shift configuration for the cluster