AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

AccessEntry

Represents an access entry in an Amazon EKS cluster. An access entry defines the permissions and scope for a user or role to access an Amazon EKS cluster.

Import

import { AccessEntry } from 'aws-cdk-lib/aws-eks';

Or use the module namespace:

import * as eks from 'aws-cdk-lib/aws-eks';
// eks.AccessEntry

Properties

Configuration passed to the constructor as AccessEntryProps.

accessPoliciesRequired
IAccessPolicy[]

The access policies that define the permissions and scope for the access entry.

clusterRequired
ICluster

The Amazon EKS cluster to which the access entry applies.

principalRequired
string

The Amazon Resource Name (ARN) of the principal (user or role) to associate the access entry with.

accessEntryNameOptional
string

The name of the AccessEntry.

Default: - No access entry name is provided

accessEntryTypeOptional
AccessEntryType

The type of the AccessEntry.

Default: STANDARD

removalPolicyOptional
RemovalPolicy

The removal policy applied to the access entry. The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations: - The resource is removed from the template, so CloudFormation stops managing it - A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it - The stack is deleted, so CloudFormation stops managing all resources in it

Default: RemovalPolicy.DESTROY

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter