aws-cdk-lib.aws_eks_v2.GrantAccessOptions

GrantAccessOptions Struct

Options for granting access to a cluster.

Source

aws-eks-v2/lib/cluster.ts

Type last changed

v2.240.0 · 23 Feb 2026

Example

declare const cluster: eks.Cluster;
declare const nodeRole: iam.Role;

// Grant access with EC2 type for Auto Mode node role
cluster.grantAccess('nodeAccess', nodeRole.roleArn, [
  eks.AccessPolicy.fromAccessPolicyName('AmazonEKSAutoNodePolicy', {
    accessScopeType: eks.AccessScopeType.CLUSTER,
  }),
], { accessEntryType: eks.AccessEntryType.EC2 });

Properties

accessEntryType?optionalAccessEntryTypeaccess_entry_type?optionalAccessEntryTypeaccessEntryType?optionalAccessEntryTypeAccessEntryType?optionalAccessEntryTypeAccessEntryType?optionalAccessEntryType#

The type of the access entry.

Default: AccessEntryType.STANDARD - Standard access entry type that supports access policies

notes

Specify AccessEntryType.EC2 for EKS Auto Mode node roles, AccessEntryType.HYBRID_LINUX for EKS Hybrid Nodes, or AccessEntryType.HYPERPOD_LINUX for SageMaker HyperPod.

Note that HYBRID_LINUX and HYPERPOD_LINUX types cannot have access policies attached per AWS EKS API constraints.