Expand description
Account-partitioned, serializable state for AWS EKS.
Models the EKS cluster control plane: clusters (with their VPC config,
logging, Kubernetes network config, and tags) plus the per-cluster Update
objects produced by UpdateClusterConfig / UpdateClusterVersion and read
back through DescribeUpdate / ListUpdates; managed node groups and
Fargate profiles (both cluster sub-resources, each with their own status
lifecycle, and node groups with their own update history), add-ons, access
entries, OIDC identity-provider configs, and Pod Identity associations (all
cluster sub-resources).
Structs§
- Access
Entry - An EKS access entry, a sub-resource of a cluster keyed by principal ARN. The access policies associated to the entry are a nested list.
- Addon
- An EKS add-on, a sub-resource of a cluster (e.g.
vpc-cni,coredns). - Associated
Policy - An access policy associated to an access entry via
AssociateAccessPolicy.access_scopeis stored as the{type, namespaces}JSON object echoed back on describe/list so the round-trip is faithful. - Capability
- An EKS cluster capability (e.g. an ACK / KRO / ArgoCD controller), a
sub-resource of a cluster keyed by
capabilityName. - Cluster
- EksAnywhere
Subscription - An EKS Anywhere subscription, an account-scoped (not cluster-scoped) resource keyed by its generated id.
- EksSnapshot
- EksState
- Fargate
Profile - A Fargate profile, a sub-resource of a cluster.
- Identity
Provider Config - An OIDC identity-provider config associated to a cluster via
AssociateIdentityProviderConfig, keyed byidentityProviderConfigName. Optional OIDC members are stored asOptions so describe only echoes the ones the caller supplied, andrequired_claimskeeps the caller’s map verbatim for a faithful round-trip. - Insight
- An upgrade-readiness/misconfiguration Insight that EKS auto-generates for a
cluster, a cluster sub-resource keyed by its generated id. Read back through
ListInsights/DescribeInsight. - Insights
Refresh - The state of the most recent
StartInsightsRefreshfor a cluster, read back throughDescribeInsightsRefresh. - Nodegroup
- A managed node group, a sub-resource of a cluster. Complex members
(scaling config, subnets, labels, taints, …) are stored as the
VpcConfigResponse-style JSON objects echoed back on every describe soDescribeNodegroupround-trips faithfully. - PodIdentity
Association - An EKS Pod Identity association, a sub-resource of a cluster keyed by its
generated
associationId. Binds a Kubernetes service account (in a namespace) to an IAM role. - Update
- A single control-plane update produced by
UpdateClusterConfigorUpdateClusterVersion.paramspreserves the(type, value)pairs AWS reports back soDescribeUpdateround-trips faithfully.
Constants§
- DEFAULT_
K8S_ VERSION - The default Kubernetes version a cluster is created with when the caller
omits
version. - EKS_
SNAPSHOT_ SCHEMA_ VERSION
Functions§
- access_
entry_ arn - Build the ARN for an access entry. AWS’s access-entry ARN embeds the
principal type (
role/user), the account, the principal’s resource name, and a random UUID:arn:aws:eks:{region}:{account}:access-entry/{cluster}/{type}/{account}/{name}/{uuid}. - addon_
arn - Build the ARN for an add-on. AWS appends a random UUID segment after
addon/{cluster}/{name}so each add-on’s ARN is unique across recreate. - capability_
arn - Build the ARN for a cluster capability. AWS appends a random UUID segment
after
capability/{cluster}/{name}so each capability’s ARN is unique. - cluster_
arn - Build the ARN for a cluster.
- default_
access_ config - The
accessConfiga cluster reports when none was supplied at create time:CONFIG_MAPauthentication (the backward-compatible default). - default_
upgrade_ policy - The
upgradePolicya cluster reports when none was supplied at create time:EXTENDEDsupport (extended support enabled by default). - eks_
anywhere_ subscription_ arn - Build the ARN for an EKS Anywhere subscription.
- fargate_
profile_ arn - Build the ARN for a Fargate profile.
- identity_
provider_ config_ arn - Build the ARN for an OIDC identity-provider config. AWS embeds the config
type (
oidc), the config name, and a random UUID. - nodegroup_
arn - Build the ARN for a node group. AWS appends a random UUID segment after
nodegroup/{cluster}/{name}so each node group’s ARN is unique even after a delete/recreate. - pod_
identity_ association_ arn - Build the ARN for a pod identity association attached to an add-on.
Type Aliases§
- Shared
EksState - TagMap
- Tags on a resource, stored by ARN so
TagResource/UntagResource/ListTagsForResourcework uniformly.