Package software.amazon.awscdk.services.eks_v2

Interface GrantAccessOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrantAccessOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-23T18:58:18.918Z")
@Stability(Stable)
public interface GrantAccessOptions
extends software.amazon.jsii.JsiiSerializable

Options for granting access to a cluster.

Example:

 Cluster cluster;
 Role nodeRole;
 // Grant access with EC2 type for Auto Mode node role
 cluster.grantAccess("nodeAccess", nodeRole.getRoleArn(), List.of(AccessPolicy.fromAccessPolicyName("AmazonEKSAutoNodePolicy", AccessPolicyNameOptions.builder()
         .accessScopeType(AccessScopeType.CLUSTER)
         .build())), GrantAccessOptions.builder().accessEntryType(AccessEntryType.EC2).build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GrantAccessOptions.Builder	A builder for GrantAccessOptions
static final class	GrantAccessOptions.Jsii$Proxy	An implementation for GrantAccessOptions

Method Summary

Modifier and Type	Method	Description
static GrantAccessOptions.Builder	builder()
default AccessEntryType	getAccessEntryType()	The type of the access entry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessEntryType

@Stability(Stable)
@Nullable
default AccessEntryType getAccessEntryType()

The type of the access entry.

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 EC2, HYBRID_LINUX, and HYPERPOD_LINUX types cannot have access policies attached per AWS EKS API constraints.

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

builder

@Stability(Stable)
static GrantAccessOptions.Builder builder()

Returns:

a GrantAccessOptions.Builder of GrantAccessOptions