Skip to main content

Module state

Module state 

Source
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§

AccessEntry
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).
AssociatedPolicy
An access policy associated to an access entry via AssociateAccessPolicy. access_scope is 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
EksAnywhereSubscription
An EKS Anywhere subscription, an account-scoped (not cluster-scoped) resource keyed by its generated id.
EksSnapshot
EksState
FargateProfile
A Fargate profile, a sub-resource of a cluster.
IdentityProviderConfig
An OIDC identity-provider config associated to a cluster via AssociateIdentityProviderConfig, keyed by identityProviderConfigName. Optional OIDC members are stored as Options so describe only echoes the ones the caller supplied, and required_claims keeps 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.
InsightsRefresh
The state of the most recent StartInsightsRefresh for a cluster, read back through DescribeInsightsRefresh.
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 so DescribeNodegroup round-trips faithfully.
PodIdentityAssociation
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 UpdateClusterConfig or UpdateClusterVersion. params preserves the (type, value) pairs AWS reports back so DescribeUpdate round-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 accessConfig a cluster reports when none was supplied at create time: CONFIG_MAP authentication (the backward-compatible default).
default_upgrade_policy
The upgradePolicy a cluster reports when none was supplied at create time: EXTENDED support (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§

SharedEksState
TagMap
Tags on a resource, stored by ARN so TagResource / UntagResource / ListTagsForResource work uniformly.