AWS EKS Service Tables

The AWS EKS Service uses the following tables

Tables

AWSEKSClusterLogging

NameTypeDescription
IDintegerThe ID of your local Amazon EKS cluster log on an AWS Outpost.
EnabledbitIf a log type is enabled, that log type exports its control plane logs to CloudWatch Logs . If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
TypesJsonstringThe available cluster control plane log types. Valid Values: api, audit, authenticator, controllerManager, scheduler
AWSEKSClusterARNstringThe Amazon Resource Name (ARN) of the cluster.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry

AWSEKSClusters

NameTypeDescription
AccessAuthenticationModestringThe current authentication mode of the cluster. Valid Values: API, API_AND_CONFIG_MAP, CONFIG_MAP
AccessBootstrapClusterCreatorAdminPermissionsbitSpecifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
ARNstringThe Amazon Resource Name (ARN) of the cluster.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
BlockStorageEnabledbitIndicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account.
CertificateAuthorityDatastringThe certificate-authority-data for your cluster.
ClientRequestTokenstringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
ComputeEnabledbitIndicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account.
ComputeNodePoolsJsonstringIndicates the current configuration of node pools in your EKS Auto Mode cluster.
ComputeNodeRoleARNstringThe ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.
ConfigIDintegerA unique identifier for the configuration associated with the EKS cluster.
ConnectorActivationCodestringA unique code associated with the cluster for registration purposes.
ConnectorActivationExpiryintegerThe expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.
ConnectorActivationIDstringA unique ID associated with the cluster for registration purposes.
ConnectorProviderstringThe cluster's cloud service provider.
ConnectorRoleARNstringThe Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
CreatedAtdatetimeThe Unix epoch timestamp at object creation.
EncryptionProviderKeyARNstringAWS Key Management Service (AWS KMS) key. Either the ARN or the alias can be used.
EncryptionResourcesJsonstringSpecifies the resources to be encrypted. The only supported value is secrets.
EndpointstringThe endpoint for your Kubernetes API server.
IDstringThe ID of your local Amazon EKS cluster on an AWS Outpost. This property isn't available for an Amazon EKS cluster on the AWS cloud.
KubernetesElasticLoadBalancingEnabledbitRequest to enable or disable the load balancing capability on your EKS Auto Mode cluster.
KubernetesIpFamilystringSpecify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, ipv4 is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify ipv6, the VPC and subnets that you specify for cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them.
KubernetesServiceIpv4CidrstringDon't specify a value if you selectipv6 for KubernetesIpFamily. The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks.
KubernetesServiceIpv6CidrstringDon't specify a value if you selectipv4 for KubernetesIpFamily.
NamestringThe name of your cluster.
OIDCIssuerstringThe issuer URL for the OIDC identity provider.
OutpostARNsJsonstringThe ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.
OutpostControlPlaneInstanceTypestringThe Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.
OutpostControlPlanePlacementGroupNamestringAn object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS Outpost.
PlatformVersionstringThe platform version of your Amazon EKS cluster.
RemoteNodeNetworksCidrsJsonstringThe list of network CIDRs that can contain hybrid nodes.
RemotePodNetworksCidrsJsonstringThe list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.
RoleARNstringThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
StatusstringThe current status of the cluster. Valid Values: CREATING, ACTIVE, DELETING, FAILED, UPDATING, PENDING
UpgradePolicySupportTypestringIf the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.
VersionstringThe Kubernetes server version for the cluster.
VPCClusterSecurityGroupIDstringThe ID of your local Amazon EKS cluster security group on an AWS Outpost.
VPCEndpointPrivateAccessbitSet this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
VPCEndpointPublicAccessbitSet this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
VPCIDstringThe ID of your local Amazon EKS VPC on an AWS Outpost.
VPCPublicAccessCidrsJsonstringThe CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and AWS Fargate Pod in the cluster.
VPCSecurityGroupIDsJsonstringSpecify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes.
VPCSubnetIDsJsonstringThe subnets associated with your cluster.
ZonalShiftConfigEnabledbitIf zonal shift is enabled, AWS configures zonal autoshift for the cluster.

AWSEKSHealthIssues

NameTypeDescription
AWSEKSClusterConfigIDintegerA unique identifier for the configuration associated with the EKS cluster.
AWSEKSNodeGroupConfigIDintegerA unique identifier for the configuration associated with the EKS node group.
AWSEKSClusterARNstringThe Amazon Resource Name (ARN) of the cluster.
AWSEKSNodeGroupARNstringThe Amazon Resource Name (ARN) of the node group.
CodestringA brief description of the error. Valid Values: PodExecutionRoleAlreadyInUse, AccessDenied, ClusterUnreachable, InternalFailure
MessagestringThe error message associated with the issue.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
IDintegerA unique identifier for the configuration associated with the EKS health issues.
ResourceIDsJsonstringThe AWS resources that are affected by this issue.

AWSEKSNodeGroups

NameTypeDescription
AmiTypestringIf the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration. Valid Values: AL2_x86_64, AL2_x86_64_GPU, AL2_ARM_64, CUSTOM, BOTTLEROCKET_ARM_64, BOTTLEROCKET_x86_64, BOTTLEROCKET_ARM_64_FIPS, BOTTLEROCKET_x86_64_FIPS, BOTTLEROCKET_ARM_64_NVIDIA, BOTTLEROCKET_x86_64_NVIDIA, WINDOWS_CORE_2019_x86_64, WINDOWS_FULL_2019_x86_64, WINDOWS_CORE_2022_x86_64, WINDOWS_FULL_2022_x86_64, AL2023_x86_64_STANDARD, AL2023_ARM_64_STANDARD, AL2023_x86_64_NEURON, AL2023_x86_64_NVIDIA
ARNstringThe Amazon Resource Name (ARN) of the node group.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
CapacityTypestringThe capacity type of your managed node group. Valid Values: ON_DEMAND, SPOT, CAPACITY_BLOCK
ClusterNamestringThe name of your cluster.
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
CreatedAtdatetimeThe Unix epoch timestamp at object creation.
DiskSizeintegerIf the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.
InstanceTypesJsonstringIf the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.
LabelsJsonstringThe Kubernetes labels applied to the nodes in the node group.
LaunchTemplateIDstringThe ID of the launch template. You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.
LaunchTemplateNamestringThe name of the launch template. You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.
LaunchTemplateVersionstringThe version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
ModifiedAtdatetimeThe Unix epoch timestamp for the last modification to the object.
NamestringThe name of the node group.
NodeRepairConfigEnabledbitSpecifies whether to enable node auto repair for the node group. Node auto repair is disabled by default.
NodeRolestringThe IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.
ReleaseVersionstringIf the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.
RemoteAccessEC2SSHKeystringThe Amazon EC2 SSH key name that provides access for SSH communication with the nodes in the managed node group.
RemoteAccessSourceSecurityGroupsJsonstringThe security group IDs that are allowed SSH access (port 22) to the nodes. For Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't specify a source security group when you create a managed node group, then the port on the nodes is opened to the internet (0.0.0.0/0).
ResourceAutoScalingGroupsNamesJsonstringThe name of the Auto Scaling group associated with an Amazon EKS managed node group.
ResourceRemoteAccessSecurityGroupstringThe remote access security group associated with the node group. This security group controls SSH access to the nodes.
ScalingDesiredSizeintegerThe current number of nodes that the managed node group should maintain.
ScalingMaxSizeintegerThe maximum number of nodes that the managed node group can scale out to.
ScalingMinSizeintegerThe minimum number of nodes that the managed node group can scale in to.
StatusstringThe current status of the managed node group. Valid Values: CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, DELETE_FAILED, DEGRADED
SubnetsJsonstringThe subnets that were specified for the Auto Scaling group that is associated with your node group.
UpdateMaxUnavailableintegerThe maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or maxUnavailablePercentage is required to have a value. The maximum number is 100.
UpdateMaxUnavailablePercentageintegerThe maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
UpdateStrategystringThe configuration for the behavior to follow during a node group version update of this managed node group. Valid Values: DEFAULT, MINIMAL
VersionstringThe Kubernetes version of the managed node group.

AWSEKSTaints

NameTypeDescription
AWSEKSNodeGroupARNstringThe Amazon Resource Name (ARN) of the node group.
EffectstringThe effect of the taint. Valid Values: `NO_SCHEDULE NO_EXECUTE, PREFER_NO_SCHEDULE
KeystringThe key of the taint.
ValuestringThe value of the taint.
BatchDatedatetimeThe date and time when the activity logs were batch-processed or recorded
ConfigIDintegerA unique identifier for the configuration associated with the activity log entry
IDintegerA unique identifier for the configuration associated with the EKS taint.

Did this page help you?