String addonName
The name of the add-on.
String clusterName
The name of the cluster.
String status
The status of the add-on.
String addonVersion
The version of the add-on.
AddonHealth health
An object that represents the health of the add-on.
String addonArn
The Amazon Resource Name (ARN) of the add-on.
Date createdAt
The date and time that the add-on was created.
Date modifiedAt
The date and time that the add-on was last modified.
String serviceAccountRoleArn
The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.
Map<K,V> tags
The metadata that you apply to the add-on to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Add-on tags do not propagate to any other resources associated with the cluster.
String clusterName
The name of the cluster that you are associating with encryption configuration.
List<E> encryptionConfig
The configuration you are using for encryption.
String clientRequestToken
The client request token you are using with the encryption configuration.
Update update
String clusterName
The name of the cluster to associate the configuration to.
OidcIdentityProviderConfigRequest oidc
An object that represents an OpenID Connect (OIDC) identity provider configuration.
Map<K,V> tags
The metadata to apply to the configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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 Amazon Web Services 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.
KubernetesNetworkConfigResponse kubernetesNetworkConfig
The Kubernetes network configuration for the cluster.
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 clusterName
The name of the cluster to create the add-on for.
String addonName
The name of the add-on. The name must match one of the names returned by
DescribeAddonVersions .
String addonVersion
The version of the add-on. The version must match one of the versions returned by
DescribeAddonVersions .
String serviceAccountRoleArn
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
String resolveConflicts
How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on.
String clientRequestToken
A 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.
Addon addon
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 the Kubernetes control plane to make calls to Amazon Web Services 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.
KubernetesNetworkConfigRequest kubernetesNetworkConfig
The Kubernetes network configuration for the cluster.
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 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. If you specify
launchTemplate, then don't specify diskSize, or the node group deployment will fail.
For more information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
List<E> subnets
The subnets to use for the Auto Scaling group that is created for your node group. If you specify
launchTemplate, then don't specify
SubnetId in your launch template, or the node group deployment will fail. For more information
about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
List<E> instanceTypes
Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify
AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate,
then you can specify zero or one instance type in your launch template or you can specify 0-20 instance
types for instanceTypes. If however, you specify an instance type in your launch template and
specify any instanceTypes, the node group deployment will fail. If you don't specify an instance
type in a launch template or for instanceTypes, then t3.medium is used, by default. If
you specify Spot for capacityType, then we recommend specifying multiple values for
instanceTypes. For more information, see Managed node group capacity types and Launch template support in the
Amazon EKS User Guide.
String amiType
The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type. Non-GPU
instances should use the AL2_x86_64 AMI type. Arm instances should use the AL2_ARM_64
AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI. If you specify launchTemplate,
and your launch template uses a custom AMI, then don't specify amiType, or the node group deployment
will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
RemoteAccessConfig remoteAccess
The remote access (SSH) configuration to use with your node group. If you specify launchTemplate,
then don't specify remoteAccess, or the node group deployment will fail. For more information about
using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
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 Amazon Web Services APIs on your behalf. Nodes receive permissions for
these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register
them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more
information, see Amazon EKS
node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then
don't specify
IamInstanceProfile in your launch template, or the node group deployment will fail. For more
information about using launch templates with Amazon EKS, see Launch template support 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.
List<E> taints
The Kubernetes taints to be applied to the nodes in the node group.
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.
LaunchTemplateSpecification launchTemplate
An object representing a node group's launch template specification. If specified, then do not specify
instanceTypes, diskSize, or remoteAccess and make sure that the launch
template meets the requirements in launchTemplateSpecification.
NodegroupUpdateConfig updateConfig
The node group update configuration.
String capacityType
The capacity type for your node group.
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. If you specify launchTemplate, and your launch
template uses a custom AMI, then don't specify version, or the node group deployment will fail. For
more information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
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 Amazon
Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and
your launch template uses a custom AMI, then don't specify releaseVersion, or the node group
deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
Nodegroup nodegroup
The full description of your new node group.
String clusterName
The name of the cluster to delete the add-on from.
String addonName
The name of the add-on. The name must match one of the names returned by ListAddons .
Boolean preserve
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it is not removed.
Addon addon
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 clusterName
The name of the cluster.
String addonName
The name of the add-on. The name must match one of the names returned by ListAddons .
Addon addon
String kubernetesVersion
The Kubernetes versions that the add-on can be used with.
Integer maxResults
The maximum number of results to return.
String nextToken
The nextToken value returned from a previous paginated DescribeAddonVersionsRequest
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.
String addonName
The name of the add-on. The name must match one of the names returned by ListAddons .
List<E> addons
The list of available versions with Kubernetes version compatibility.
String nextToken
The nextToken value returned from a previous paginated DescribeAddonVersionsResponse
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.
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.
String clusterName
The cluster name that the identity provider configuration is associated to.
IdentityProviderConfig identityProviderConfig
An object that represents an identity provider configuration.
IdentityProviderConfigResponse identityProviderConfig
The object that represents an OpenID Connect (OIDC) identity provider configuration.
Nodegroup nodegroup
The full description of your node group.
String name
The name of the Amazon EKS cluster associated with the update.
String updateId
The ID of the update to describe.
String nodegroupName
The name of the Amazon EKS node group associated with the update.
String addonName
The name of the add-on. The name must match one of the names returned by ListAddons .
Update update
The full description of the specified update.
String clusterName
The name of the cluster to disassociate an identity provider from.
IdentityProviderConfig identityProviderConfig
An object that represents an identity provider configuration.
String clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Update 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
An object representing the OpenID Connect identity provider information.
OidcIdentityProviderConfig oidc
An object that represents an OpenID Connect (OIDC) identity provider configuration.
String clusterName
The Amazon EKS cluster associated with the exception.
String nodegroupName
The Amazon EKS managed node group associated with the exception.
String fargateProfileName
The Fargate profile associated with the exception.
String addonName
String code
A brief description of the error.
AccessDenied: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.
AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
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.
ClusterUnreachable: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests.
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.
Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
Ec2SubnetInvalidConfiguration: One or more Amazon EC2 subnets specified for a node group do not
automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned
a public IP address, then you need to enable the auto-assign public IP address setting for the
subnet. See Modifying the
public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.
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.
InstanceLimitExceeded: Your Amazon Web Services 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.
InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient node IAM role permissions or lack of outbound internet access for the nodes.
String message
The error message associated with the issue.
List<E> resourceIds
The Amazon Web Services resources that are afflicted by this issue.
String serviceIpv4Cidr
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. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC. The block must meet the following requirements:
Within one of the following private IP address blocks: 10.0.0.0/8, 172.16.0.0.0/12, or 192.168.0.0/16.
Doesn't overlap with any CIDR block assigned to the VPC that you selected for VPC.
Between /24 and /12.
You can only specify a custom CIDR block when you create a cluster and can't change this value once the cluster is created.
String serviceIpv4Cidr
The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it cannot be changed.
String clusterName
The name of the cluster.
Integer maxResults
The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use
this parameter, ListAddonsRequest 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 ListAddonsRequest request with the returned nextToken value. This value
can be between 1 and 100. If you don't use this parameter, ListAddonsRequest returns up to 100
results and a nextToken value, if applicable.
String nextToken
The nextToken value returned from a previous paginated ListAddonsRequest 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> addons
A list of available add-ons.
String nextToken
The nextToken value returned from a previous paginated ListAddonsResponse 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.
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 list Fargate 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 cluster name that you want to list identity provider configurations for.
Integer maxResults
The maximum number of identity provider configurations returned by ListIdentityProviderConfigs in
paginated output. When you use this parameter, ListIdentityProviderConfigs 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 ListIdentityProviderConfigs
request with the returned nextToken value. This value can be between 1 and 100. If you don't use
this parameter, ListIdentityProviderConfigs returns up to 100 results and a nextToken
value, if applicable.
String nextToken
The nextToken value returned from a previous paginated IdentityProviderConfigsRequest
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> identityProviderConfigs
The identity provider configurations for the cluster.
String nextToken
The nextToken value returned from a previous paginated
ListIdentityProviderConfigsResponse 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.
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 addonName
The names of the installed add-ons that have available updates.
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
If 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.
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.
String capacityType
The capacity type of your managed node group.
NodegroupScalingConfig scalingConfig
The scaling configuration details for the Auto Scaling group that is associated with your node group.
List<E> instanceTypes
If 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.
List<E> subnets
The subnets that were specified for the Auto Scaling group that is associated with your node group.
RemoteAccessConfig remoteAccess
If the node group wasn't deployed with a launch template, then this is the remote access configuration that is
associated with the node group. If the node group was deployed with a launch template, then this is
null.
String amiType
If 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.
String nodeRole
The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to
Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance
profile and associated policies.
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.
List<E> taints
The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of
No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints can be
used together with tolerations to control how workloads are scheduled to your nodes.
NodegroupResources resources
The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
Integer diskSize
If 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.
NodegroupHealth health
The health status of the node group. If there are issues with your node group's health, they are listed here.
NodegroupUpdateConfig updateConfig
The node group update configuration.
LaunchTemplateSpecification launchTemplate
If a launch template was used to create the node group, then this is the launch template that was used.
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 nodes that the managed node group can scale in to.
Integer maxSize
The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.
Integer desiredSize
The current number of nodes that the managed node group should maintain.
Integer maxUnavailable
The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This
value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
Integer maxUnavailablePercentage
The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in
parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
String issuer
The issuer URL for the OIDC identity provider.
String identityProviderConfigName
The name of the configuration.
String identityProviderConfigArn
The ARN of the configuration.
String clusterName
The cluster that the configuration is associated to.
String issuerUrl
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
String clientId
This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
String usernameClaim
The JSON Web token (JWT) claim that is used as the username.
String usernamePrefix
The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain
system:
String groupsClaim
The JSON web token (JWT) claim that the provider uses to return your groups.
String groupsPrefix
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups). For example, the value oidc: creates group names like oidc:engineering and
oidc:infra. The prefix can't contain system:
Map<K,V> requiredClaims
The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
Map<K,V> tags
The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you defined.
String status
The status of the OIDC identity provider.
String identityProviderConfigName
The name of the OIDC provider configuration.
String issuerUrl
The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying
tokens. The URL must begin with https:// and should correspond to the iss claim in the
provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not.
Typically the URL consists of only a hostname, like https://server.example.org or
https://example.com. This URL should point to the level below
.well-known/openid-configuration and must be publicly accessible over the internet.
String clientId
This is also known as audience. The ID for the client application that makes authentication requests to the OpenID identity provider.
String usernameClaim
The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a
unique identifier of the end user. You can choose other claims, such as email or name,
depending on the OpenID identity provider. Claims other than email are prefixed with the issuer URL
to prevent naming clashes with other plug-ins.
String usernamePrefix
The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide
this field, and username is a value other than email, the prefix defaults to
issuerurl#. You can use the value - to disable all prefixing.
String groupsClaim
The JWT claim that the provider uses to return your groups.
String groupsPrefix
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups). For example, the value oidc: will create group names like oidc:engineering and
oidc:infra.
Map<K,V> requiredClaims
The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide.
String keyArn
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key. For more information, see Allowing Users in Other Accounts to Use a KMS key in the Key Management Service Developer Guide.
String ec2SshKey
The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances 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 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 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.
String fargateProfileName
The Fargate profile associated with the exception.
String addonName
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 clusterName
The name of the cluster.
String addonName
The name of the add-on. The name must match one of the names returned by ListAddons .
String addonVersion
The version of the add-on. The version must match one of the versions returned by
DescribeAddonVersions .
String serviceAccountRoleArn
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.
String resolveConflicts
How to resolve parameter value conflicts when applying the new version of the add-on to the cluster.
String clientRequestToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Update 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 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.
UpdateTaintsPayload taints
The Kubernetes taints 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.
NodegroupUpdateConfig updateConfig
The node group update configuration.
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. If you specify launchTemplate, and your launch template
uses a custom AMI, then don't specify version, or the node group update will fail. For more
information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
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 Amazon
Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and
your launch template uses a custom AMI, then don't specify releaseVersion, or the node group update
will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the
Amazon EKS User Guide.
LaunchTemplateSpecification launchTemplate
An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.
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 nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your 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 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:
1.14 Amazon EKS platform version eks.2 and earlier
1.14 Amazon EKS platform version eks.3 and later
For more information, see Amazon EKS security group considerations in the Amazon EKS User Guide .
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 nodes or Fargate pods in the cluster, then
ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the 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 nodes or 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 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 nodes or Fargate
pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for
communication with the 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 nodes or 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 © 2021. All rights reserved.