Actions, resources, and condition keys for Amazon Elastic Kubernetes Service

Amazon Elastic Kubernetes Service (service prefix: eks) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Learn how to configure this service.
View a list of the API operations available for this service.
Learn how to secure this service and its resources by using IAM permission policies.

Topics

Actions defined by Amazon Elastic Kubernetes Service
Resource types defined by Amazon Elastic Kubernetes Service
Condition keys for Amazon Elastic Kubernetes Service

Actions defined by Amazon Elastic Kubernetes Service

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in Amazon. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys
AccessKubernetesApi [permission only]	Grants permission to view Kubernetes objects via Amazon EKS console	Read	cluster*
AssociateAccessPolicy	Grants permission to associate an Amazon EKS access policy to an Amazon EKS access entry	Write	access-entry*
AssociateAccessPolicy		Write		eks:policyArn eks:namespaces eks:accessScope
AssociateEncryptionConfig	Grants permission to associate encryption configuration to a cluster	Write	cluster*
AssociateIdentityProviderConfig	Grants permission to associate an identity provider configuration to a cluster	Write	cluster*
AssociateIdentityProviderConfig		Write		aws:RequestTag/${TagKey} aws:TagKeys eks:clientId eks:issuerUrl
CreateAccessEntry	Grants permission to create an Amazon EKS access entry	Write	cluster*
CreateAccessEntry	Grants permission to create an Amazon EKS access entry	Write		aws:RequestTag/${TagKey} aws:TagKeys eks:principalArn eks:kubernetesGroups eks:username eks:accessEntryType
CreateAddon	Grants permission to create an Amazon EKS add-on	Write	cluster*
CreateAddon	Grants permission to create an Amazon EKS add-on	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateCluster	Grants permission to create an Amazon EKS cluster	Write		aws:RequestTag/${TagKey} aws:TagKeys eks:bootstrapClusterCreatorAdminPermissions
CreateEksAnywhereSubscription	Grants permission to create an EKS Anywhere subscription	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateFargateProfile	Grants permission to create an Amazon Fargate profile	Write	cluster*
CreateFargateProfile	Grants permission to create an Amazon Fargate profile	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateNodegroup	Grants permission to create an Amazon EKS Nodegroup	Write	cluster*
CreateNodegroup	Grants permission to create an Amazon EKS Nodegroup	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreatePodIdentityAssociation	Grants permission to create an EKS Pod Identity association	Write	cluster*
CreatePodIdentityAssociation	Grants permission to create an EKS Pod Identity association	Write		aws:RequestTag/${TagKey} aws:TagKeys
DeleteAccessEntry	Grants permission to delete an Amazon EKS access entry	Write	access-entry*
DeleteAddon	Grants permission to delete an Amazon EKS add-on	Write	addon*
DeleteCluster	Grants permission to delete an Amazon EKS cluster	Write	cluster*
DeleteEksAnywhereSubscription	Grants permission to describe an EKS Anywhere subscription	Write	eks-anywhere-subscription*
DeleteFargateProfile	Grants permission to delete an Amazon Fargate profile	Write	fargateprofile*
DeleteNodegroup	Grants permission to delete an Amazon EKS Nodegroup	Write	nodegroup*
DeletePodIdentityAssociation	Grants permission to delete an EKS Pod Identity association	Write	podidentityassociation*
DeregisterCluster	Grants permission to deregister an External cluster	Write	cluster*
DescribeAccessEntry	Grants permission to describe an Amazon EKS access entry	Read	access-entry*
DescribeAddon	Grants permission to retrieve descriptive information about an Amazon EKS add-on	Read	addon*
DescribeAddonConfiguration	Grants permission to list configuration options about an Amazon EKS add-on	Read
DescribeAddonVersions	Grants permission to retrieve descriptive version information about the add-ons that Amazon EKS Add-ons supports	Read
DescribeCluster	Grants permission to retrieve descriptive information about an Amazon EKS cluster	Read	cluster*
DescribeEksAnywhereSubscription	Grants permission to describe an EKS Anywhere subscription	Read	eks-anywhere-subscription*
DescribeFargateProfile	Grants permission to retrieve descriptive information about an Amazon Fargate profile associated with a cluster	Read	fargateprofile*
DescribeIdentityProviderConfig	Grants permission to retrieve descriptive information about an Idp config associated with a cluster	Read	identityproviderconfig*
DescribeInsight	Grants permission to retrieve descriptive information of a detected insight for a specified cluster	Read	cluster*
DescribeNodegroup	Grants permission to retrieve descriptive information about an Amazon EKS nodegroup	Read	nodegroup*
DescribePodIdentityAssociation	Grants permission to describe an EKS Pod Identity association	Read	podidentityassociation*
DescribeUpdate	Grants permission to retrieve a given update for a given Amazon EKS cluster/nodegroup/add-on (in the specified or default region)	Read	cluster*
			addon
			nodegroup
DisassociateAccessPolicy	Grants permission to disassociate an Amazon EKS access policy from an Amazon EKS acces entry	Write	access-entry*
DisassociateAccessPolicy		Write		eks:policyArn eks:namespaces eks:accessScope
DisassociateIdentityProviderConfig	Grants permission to delete an asssociated Idp config	Write	identityproviderconfig*
ListAccessEntries	Grants permission to list all Amazon EKS access entries	List	cluster*
ListAccessPolicies	Grants permission to list Amazon EKS access policies	List
ListAddons	Grants permission to list the Amazon EKS add-ons in your Amazon Web Services account (in the specified or default region) for a given cluster	List	cluster*
ListAssociatedAccessPolicies	Grants permission to list associated access policy on and Amazon EKS access entry	List	access-entry*
ListClusters	Grants permission to list the Amazon EKS clusters in your Amazon Web Services account (in the specified or default region)	List
ListEksAnywhereSubscriptions	Grants permission to list EKS Anywhere subscriptions	List
ListFargateProfiles	Grants permission to list the Amazon Fargate profiles in your Amazon Web Services account (in the specified or default region) associated with a given cluster	List	cluster*
ListIdentityProviderConfigs	Grants permission to list the Idp configs in your Amazon Web Services account (in the specified or default region) associated with a given cluster	List	cluster*
ListInsights	Grants permission to list all detected insights for a specified cluster	List	cluster*
ListNodegroups	Grants permission to list the Amazon EKS nodegroups in your Amazon Web Services account (in the specified or default region) attached to given cluster	List	cluster*
ListPodIdentityAssociations	Grants permission to list EKS Pod Identity associations	List	cluster*
ListTagsForResource	Grants permission to list tags for the specified resource	Read	addon
			cluster
			eks-anywhere-subscription
			fargateprofile
			identityproviderconfig
			nodegroup
ListUpdates	Grants permission to list the updates for a given Amazon EKS cluster/nodegroup/add-on (in the specified or default region)	List	cluster*
			addon
			nodegroup
RegisterCluster	Grants permission to register an External cluster	Write		aws:RequestTag/${TagKey} aws:TagKeys
TagResource	Grants permission to tag the specified resource	Tagging	access-entry
			addon
			cluster
			eks-anywhere-subscription
			fargateprofile
			identityproviderconfig
			nodegroup
			podidentityassociation
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to untag the specified resource	Tagging	access-entry
			addon
			cluster
			eks-anywhere-subscription
			fargateprofile
			identityproviderconfig
			nodegroup
			podidentityassociation
				aws:TagKeys
UpdateAccessEntry	Grants permission to update an Amazon EKS access entry	Write	access-entry*
UpdateAddon	Grants permission to update Amazon EKS add-on configurations, such as the VPC-CNI version	Write	addon*
UpdateClusterConfig	Grants permission to update Amazon EKS cluster configurations (eg: API server endpoint access)	Write	cluster*
UpdateClusterVersion	Grants permission to update the Kubernetes version of an Amazon EKS cluster	Write	cluster*
UpdateEksAnywhereSubscription	Grants permission to update an EKS Anywhere subscription	Write	eks-anywhere-subscription*
UpdateNodegroupConfig	Grants permission to update Amazon EKS nodegroup configurations (eg: min/max/desired capacity or labels)	Write	nodegroup*
UpdateNodegroupVersion	Grants permission to update the Kubernetes version of an Amazon EKS nodegroup	Write	nodegroup*
UpdatePodIdentityAssociation	Grants permission to update an EKS Pod Identity association	Write	podidentityassociation*

Resource types defined by Amazon Elastic Kubernetes Service

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
cluster	`arn:${Partition}:eks:${Region}:${Account}:cluster/${ClusterName}`	aws:ResourceTag/${TagKey}
nodegroup	`arn:${Partition}:eks:${Region}:${Account}:nodegroup/${ClusterName}/${NodegroupName}/${UUID}`	aws:ResourceTag/${TagKey}
addon	`arn:${Partition}:eks:${Region}:${Account}:addon/${ClusterName}/${AddonName}/${UUID}`	aws:ResourceTag/${TagKey}
fargateprofile	`arn:${Partition}:eks:${Region}:${Account}:fargateprofile/${ClusterName}/${FargateProfileName}/${UUID}`	aws:ResourceTag/${TagKey}
identityproviderconfig	`arn:${Partition}:eks:${Region}:${Account}:identityproviderconfig/${ClusterName}/${IdentityProviderType}/${IdentityProviderConfigName}/${UUID}`	aws:ResourceTag/${TagKey}
eks-anywhere-subscription	`arn:${Partition}:eks:${Region}:${Account}:eks-anywhere-subscription/${UUID}`	aws:ResourceTag/${TagKey}
podidentityassociation	`arn:${Partition}:eks:${Region}:${Account}:podidentityassociation/${ClusterName}/${UUID}`	aws:ResourceTag/${TagKey}
access-entry	`arn:${Partition}:eks:${Region}:${Account}:access-entry/${ClusterName}/${IamIdentityType}/${IamIdentityAccountID}/${IamIdentityName}/${UUID}`	aws:ResourceTag/${TagKey} eks:accessEntryType eks:clusterName eks:kubernetesGroups eks:principalArn eks:username
access-policy	`arn:${Partition}:eks::aws:cluster-access-policy/${AccessPolicyName}`

Condition keys for Amazon Elastic Kubernetes Service

Amazon Elastic Kubernetes Service defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by a key that is present in the request the user makes to the EKS service	String
aws:ResourceTag/${TagKey}	Filters access by a tag key and value pair	String
aws:TagKeys	Filters access by the list of all the tag key names present in the request the user makes to the EKS service	ArrayOfString
eks:accessEntryType	Filters access by the access entry type present in the access entry requests the user makes to the EKS service	String
eks:accessScope	Filters access by the accessScope present in the associate / disassociate access policy requests the user makes to the EKS service	String
eks:bootstrapClusterCreatorAdminPermissions	Filters access by the bootstrapClusterCreatorAdminPermissions present in the create cluster request	Bool
eks:clientId	Filters access by the clientId present in the associateIdentityProviderConfig request the user makes to the EKS service	String
eks:clusterName	Filters access by the clusterName present in the access entry requests the user makes to the EKS service	String
eks:issuerUrl	Filters access by the issuerUrl present in the associateIdentityProviderConfig request the user makes to the EKS service	String
eks:kubernetesGroups	Filters access by the kubernetesGroups present in the access entry requests the user makes to the EKS service	ArrayOfString
eks:namespaces	Filters access by the namespaces present in the associate / disassociate access policy requests the user makes to the EKS service	ArrayOfString
eks:policyArn	Filters access by the policyArn present in the access entry requests the user makes to the EKS service	ARN
eks:principalArn	Filters access by the principalArn present in the access entry requests requests the user makes to the EKS service	ARN
eks:username	Filters access by the Kubernetes username present in the access entry requests the user makes to the EKS service	String

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Amazon Elastic File System

Amazon Elastic Load Balancing