AccessEntry - Amazon EKS
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AccessEntry

An access entry allows an IAM principal (user or role) to access your cluster. Access entries can replace the need to maintain the aws-auth ConfigMap for authentication. For more information about access entries, see Access entries in the Amazon EKS User Guide.

Contents

accessEntryArn

The ARN of the access entry.

Type: String

Required: No

clusterName

The name of your cluster.

Type: String

Required: No

createdAt

The Unix epoch timestamp at object creation.

Type: Timestamp

Required: No

kubernetesGroups

A name that you've specified in a Kubernetes RoleBinding or ClusterRoleBinding object so that Kubernetes authorizes the principalARN access to cluster objects.

Type: Array of strings

Required: No

modifiedAt

The Unix epoch timestamp for the last modification to the object.

Type: Timestamp

Required: No

principalArn

The ARN of the IAM principal for the access entry. If you ever delete the IAM principal with this ARN, the access entry isn't automatically deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever recreate the IAM principal, even if it has the same ARN, the access entry won't work. This is because even though the ARN is the same for the recreated IAM principal, the roleID or userID (you can see this with the Amazon Security Token Service GetCallerIdentity API) is different for the recreated IAM principal than it was for the original IAM principal. Even though you don't see the IAM principal's roleID or userID for an access entry, Amazon EKS stores it with the access entry.

Type: String

Required: No

tags

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon resources.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

type

The type of the access entry.

Type: String

Required: No

username

The name of a user that can authenticate to your cluster.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: