Using roles for Amazon EKS local clusters on Outpost
Amazon Elastic Kubernetes Service uses AWS Identity and Access Management (IAM) service-linked roles. A service-linked role is a unique type of IAM role that is linked directly to Amazon EKS. Service-linked roles are predefined by Amazon EKS and include all the permissions that the service requires to call other AWS services on your behalf.
A service-linked role makes setting up Amazon EKS easier because you don’t have to manually add the necessary permissions. Amazon EKS defines the permissions of its service-linked roles, and unless defined otherwise, only Amazon EKS can assume its roles. The defined permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity.
You can delete a service-linked role only after first deleting their related resources. This protects your Amazon EKS resources because you can’t inadvertently remove permission to access the resources.
For information about other services that support service-linked roles, see AWS services that work with IAM and look for the services that have Yes in the Service-linked role column. Choose a Yes with a link to view the service-linked role documentation for that service.
Service-linked role permissions for Amazon EKS
Amazon EKS uses the service-linked role named AWSServiceRoleForAmazonEKSLocalOutpost. The role allows Amazon EKS to manage local clusters in your account. The attached policies allow the role to manage the following resources: network interfaces, security groups, logs, and Amazon EC2 instances.
Note
The AWSServiceRoleForAmazonEKSLocalOutpost service-linked role is distinct from the role required for cluster creation. For more information, see Amazon EKS cluster IAM role.
The AWSServiceRoleForAmazonEKSLocalOutpost service-linked role trusts the following services to assume the role:
-
outposts.eks-local.amazonaws.com
The role permissions policy allows Amazon EKS to complete the following actions on the specified resources:
You must configure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide.
Creating a service-linked role for Amazon EKS
You don’t need to manually create a service-linked role. When you create a cluster in the AWS Management Console, the AWS CLI, or the AWS API, Amazon EKS creates the service-linked role for you.
If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create a cluster, Amazon EKS creates the service-linked role for you again.
Editing a service-linked role for Amazon EKS
Amazon EKS does not allow you to edit the AWSServiceRoleForAmazonEKSLocalOutpost service-linked role. After you create a service-linked role, you can’t change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide.
Deleting a service-linked role for Amazon EKS
If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up your service-linked role before you can manually delete it.
Cleaning up a service-linked role
Before you can use IAM to delete a service-linked role, you must first delete any resources used by the role.
Note
If the Amazon EKS service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again.
-
Open the Amazon EKS console
. -
In the left navigation pane, choose Amazon EKS Clusters.
-
If your cluster has any node groups or Fargate profiles, you must delete them before you can delete the cluster. For more information, see Delete a managed node group from your cluster and Delete a Fargate profile.
-
On the Clusters page, choose the cluster that you want to delete and choose Delete.
-
Type the name of the cluster in the deletion confirmation window, and then choose Delete.
-
Repeat this procedure for any other clusters in your account. Wait for all of the delete operations to finish.
Manually delete the service-linked role
Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForAmazonEKSLocalOutpost service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide.
Supported regions for Amazon EKS service-linked roles
Amazon EKS supports using service-linked roles in all of the regions where the service is available. For more information, see Amazon EKS endpoints and quotas.
