String name
The name of the Auto Scaling group associated with an Amazon EKS managed node group.
String data
The Base64-encoded certificate data required to communicate with your cluster. Add this to the
certificate-authority-data section of the kubeconfig file for your cluster.
String name
The name of the cluster.
String arn
The Amazon Resource Name (ARN) of the cluster.
Date createdAt
The Unix epoch timestamp in seconds for when the cluster was created.
String version
The Kubernetes server version for the cluster.
String endpoint
The endpoint for your Kubernetes API server.
String roleArn
The 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.
VpcConfigResponse resourcesVpcConfig
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide.
Logging logging
The logging configuration for your cluster.
Identity identity
The identity provider information for the cluster.
String status
The current status of the cluster.
Certificate certificateAuthority
The certificate-authority-data for your cluster.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String platformVersion
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
Map<K,V> tags
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
List<E> encryptionConfig
The encryption configuration for the cluster.
String name
The unique name to give to your cluster.
String version
The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .
VpcConfigRequest resourcesVpcConfig
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
Logging logging
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Map<K,V> tags
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.
List<E> encryptionConfig
The encryption configuration for the cluster.
Cluster cluster
The full description of your new cluster.
String fargateProfileName
The name of the Fargate profile.
String clusterName
The name of the Amazon EKS cluster to apply the Fargate profile to.
String podExecutionRoleArn
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.
List<E> subnets
The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.
List<E> selectors
The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Map<K,V> tags
The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
FargateProfile fargateProfile
The full description of your new Fargate profile.
String clusterName
The name of the cluster to create the node group in.
String nodegroupName
The unique name to give your node group.
NodegroupScalingConfig scalingConfig
The scaling configuration details for the Auto Scaling group that is created for your node group.
Integer diskSize
The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
List<E> subnets
The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the
tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where
CLUSTER_NAME is replaced with the name of your cluster.
List<E> instanceTypes
The instance type to use for your node group. Currently, you can specify a single instance type for a node group.
The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to
specify the AL2_x86_64_GPU with the amiType parameter.
String amiType
The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which
uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the
AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
RemoteAccessConfig remoteAccess
The remote access (SSH) configuration to use with your node group.
String nodeRole
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node
kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these
API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and
register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched.
For more information, see Amazon EKS Worker Node IAM
Role in the Amazon EKS User Guide .
Map<K,V> labels
The Kubernetes labels to be applied to the nodes in the node group when they are created.
Map<K,V> tags
The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String version
The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value.
String releaseVersion
The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
Nodegroup nodegroup
The full description of your new node group.
String name
The name of the cluster to delete.
Cluster cluster
The full description of the cluster to delete.
FargateProfile fargateProfile
The deleted Fargate profile.
Nodegroup nodegroup
The full description of your deleted node group.
String name
The name of the cluster to describe.
Cluster cluster
The full description of your specified cluster.
FargateProfile fargateProfile
The full description of your Fargate profile.
Nodegroup nodegroup
The full description of your node group.
Update update
The full description of the specified update.
String errorCode
A brief description of the error.
SubnetNotFound: We couldn't find one of the subnets associated with the cluster.
SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.
EniLimitReached: You have reached the elastic network interface limit for your account.
IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.
AccessDenied: You don't have permissions to perform the specified operation.
OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.
VpcIdNotFound: We couldn't find the VPC associated with the cluster.
String errorMessage
A more complete description of the error.
List<E> resourceIds
An optional field that contains the resource IDs associated with the error.
String fargateProfileName
The name of the Fargate profile.
String fargateProfileArn
The full Amazon Resource Name (ARN) of the Fargate profile.
String clusterName
The name of the Amazon EKS cluster that the Fargate profile belongs to.
Date createdAt
The Unix epoch timestamp in seconds for when the Fargate profile was created.
String podExecutionRoleArn
The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.
List<E> subnets
The IDs of subnets to launch pods into.
List<E> selectors
The selectors to match for pods to use this Fargate profile.
String status
The current status of the Fargate profile.
Map<K,V> tags
The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
OIDC oidc
The OpenID Connect identity provider information for the cluster.
String code
A brief description of the error.
AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.
IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient worker node IAM role permissions or lack of outbound internet access for the nodes.
InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
AccessDenied: Amazon EKS or one or more of your managed nodes is unable to communicate with your cluster API server.
InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
String message
The error message associated with the issue.
List<E> resourceIds
The AWS resources that are afflicted by this issue.
Integer maxResults
The maximum number of cluster results returned by ListClusters in paginated output. When you use
this parameter, ListClusters returns only maxResults results in a single page along
with a nextToken response element. You can see the remaining results of the initial request by
sending another ListClusters request with the returned nextToken value. This value can
be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a
nextToken value if applicable.
String nextToken
The nextToken value returned from a previous paginated ListClusters request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
List<E> clusters
A list of all of the clusters for your account in the specified Region.
String nextToken
The nextToken value to include in a future ListClusters request. When the results of a
ListClusters request exceed maxResults, you can use this value to retrieve the next
page of results. This value is null when there are no more results to return.
String clusterName
The name of the Amazon EKS cluster that you would like to listFargate profiles in.
Integer maxResults
The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output.
When you use this parameter, ListFargateProfiles returns only maxResults results in a
single page along with a nextToken response element. You can see the remaining results of the
initial request by sending another ListFargateProfiles request with the returned
nextToken value. This value can be between 1 and 100. If you don't use this parameter,
ListFargateProfiles returns up to 100 results and a nextToken value if applicable.
String nextToken
The nextToken value returned from a previous paginated ListFargateProfiles request
where maxResults was used and the results exceeded the value of that parameter. Pagination continues
from the end of the previous results that returned the nextToken value.
List<E> fargateProfileNames
A list of all of the Fargate profiles associated with the specified cluster.
String nextToken
The nextToken value to include in a future ListFargateProfiles request. When the
results of a ListFargateProfiles request exceed maxResults, you can use this value to
retrieve the next page of results. This value is null when there are no more results to return.
String clusterName
The name of the Amazon EKS cluster that you would like to list node groups in.
Integer maxResults
The maximum number of node group results returned by ListNodegroups in paginated output. When you
use this parameter, ListNodegroups returns only maxResults results in a single page
along with a nextToken response element. You can see the remaining results of the initial request by
sending another ListNodegroups request with the returned nextToken value. This value
can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results
and a nextToken value if applicable.
String nextToken
The nextToken value returned from a previous paginated ListNodegroups request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
List<E> nodegroups
A list of all of the node groups associated with the specified cluster.
String nextToken
The nextToken value to include in a future ListNodegroups request. When the results of
a ListNodegroups request exceed maxResults, you can use this value to retrieve the next
page of results. This value is null when there are no more results to return.
String resourceArn
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.
String name
The name of the Amazon EKS cluster to list updates for.
String nodegroupName
The name of the Amazon EKS managed node group to list updates for.
String nextToken
The nextToken value returned from a previous paginated ListUpdates request where
maxResults was used and the results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
Integer maxResults
The maximum number of update results returned by ListUpdates in paginated output. When you use this
parameter, ListUpdates returns only maxResults results in a single page along with a
nextToken response element. You can see the remaining results of the initial request by sending
another ListUpdates request with the returned nextToken value. This value can be
between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a
nextToken value if applicable.
List<E> updateIds
A list of all the updates for the specified cluster and Region.
String nextToken
The nextToken value to include in a future ListUpdates request. When the results of a
ListUpdates request exceed maxResults, you can use this value to retrieve the next page
of results. This value is null when there are no more results to return.
List<E> types
The available cluster control plane log types.
Boolean enabled
If 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.
String nodegroupName
The name associated with an Amazon EKS managed node group.
String nodegroupArn
The Amazon Resource Name (ARN) associated with the managed node group.
String clusterName
The name of the cluster that the managed node group resides in.
String version
The Kubernetes version of the managed node group.
String releaseVersion
The AMI version of the managed node group. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
Date createdAt
The Unix epoch timestamp in seconds for when the managed node group was created.
Date modifiedAt
The Unix epoch timestamp in seconds for when the managed node group was last modified.
String status
The current status of the managed node group.
NodegroupScalingConfig scalingConfig
The scaling configuration details for the Auto Scaling group that is associated with your node group.
List<E> instanceTypes
The instance types associated with your node group.
List<E> subnets
The subnets allowed for the Auto Scaling group that is associated with your node group. These subnets must have
the following tag: kubernetes.io/cluster/CLUSTER_NAME, where CLUSTER_NAME is replaced
with the name of your cluster.
RemoteAccessConfig remoteAccess
The remote access (SSH) configuration that is associated with the node group.
String amiType
The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU AMI
type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the
AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
String nodeRole
The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls
to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile
and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an
IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM
Role in the Amazon EKS User Guide .
Map<K,V> labels
The Kubernetes labels applied to the nodes in the node group.
Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.
NodegroupResources resources
The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
Integer diskSize
The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
NodegroupHealth health
The health status of the node group. If there are issues with your node group's health, they are listed here.
Map<K,V> tags
The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
Integer minSize
The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.
Integer maxSize
The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.
Integer desiredSize
The current number of worker nodes that the managed node group should maintain.
String issuer
The issuer URL for the OpenID Connect identity provider.
String keyArn
Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see Allowing Users in Other Accounts to Use a CMK in the AWS Key Management Service Developer Guide.
String ec2SshKey
The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
List<E> sourceSecurityGroups
The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
String clusterName
The Amazon EKS cluster associated with the exception.
String nodegroupName
The Amazon EKS managed node group associated with the exception.
List<E> validZones
The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.
String id
A UUID that is used to track the update.
String status
The current status of the update.
String type
The type of the update.
List<E> params
A key-value map that contains the parameters associated with the update.
Date createdAt
The Unix epoch timestamp in seconds for when the update was created.
List<E> errors
Any errors associated with a Failed update.
String name
The name of the Amazon EKS cluster to update.
VpcConfigRequest resourcesVpcConfig
Logging logging
Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Update update
Update update
The full description of the specified update
String clusterName
The name of the Amazon EKS cluster that the managed node group resides in.
String nodegroupName
The name of the managed node group to update.
UpdateLabelsPayload labels
The Kubernetes labels to be applied to the nodes in the node group after the update.
NodegroupScalingConfig scalingConfig
The scaling configuration details for the Auto Scaling group after the update.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Update update
String clusterName
The name of the Amazon EKS cluster that is associated with the managed node group to update.
String nodegroupName
The name of the managed node group to update.
String version
The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version.
String releaseVersion
The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide.
Boolean force
Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Update update
List<E> subnetIds
Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.
List<E> securityGroupIds
Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
Boolean endpointPublicAccess
Set 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. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
Boolean endpointPrivateAccess
Set 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 worker nodes or AWS Fargate pods in the
cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication
with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
List<E> publicAccessCidrs
The 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 and you have worker nodes or AWS Fargate pods
in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
List<E> subnetIds
The subnets associated with your cluster.
List<E> securityGroupIds
The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.
String clusterSecurityGroupId
The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
String vpcId
The VPC associated with your cluster.
Boolean endpointPublicAccess
This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
Boolean endpointPrivateAccess
This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private
API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the
private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or
AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR
blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
List<E> publicAccessCidrs
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to
the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is
0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods
in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access
Control in the Amazon EKS User Guide .
Copyright © 2020. All rights reserved.