# 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.

Extends: Construct › Resource › AccessEntry
Implements: IResource, IAccessEntry, IEnvironmentAware, IAccessEntryRef, IConstruct, IDependable

- CloudFormation: [`AWS::EKS::AccessEntry`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-eks-accessentry.html)
- L1 type: [`CfnAccessEntry`](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.CfnAccessEntry.html)
- Source: [`aws-eks/lib/access-entry.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-eks/lib/access-entry.ts#L349)
- Type last changed: v2.236.0 · 23 Jan 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_eks as eks } from 'aws-cdk-lib';

declare const accessPolicy: eks.AccessPolicy;
declare const cluster: eks.Cluster;
const accessEntry = new eks.AccessEntry(this, 'MyAccessEntry', {
  accessPolicies: [accessPolicy],
  cluster: cluster,
  principal: 'principal',

  // the properties below are optional
  accessEntryName: 'accessEntryName',
  accessEntryType: eks.AccessEntryType.STANDARD,
  removalPolicy: cdk.RemovalPolicy.DESTROY,
});
```

## Initializer

```ts
new AccessEntry(scope: Construct, id: string, props: AccessEntryProps)
```

## Construct Props

- `accessEntryName`: string — The name of the AccessEntry.

  **Default:** No access entry name is provided

- `accessEntryType`: [AccessEntryType](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.AccessEntryType.html) = STANDARD — The type of the AccessEntry.

- `accessPolicies`: [IAccessPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.IAccessPolicy.html)[] (required) — The access policies that define the permissions and scope for the access entry.

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.ICluster.html) (required) — The Amazon EKS cluster to which the access entry applies.

- `principal`: string (required) — The Amazon Resource Name (ARN) of the principal (user or role) to associate the access entry with.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.DESTROY — 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

## Properties

- `accessEntryArn`: string (required) — The Amazon Resource Name (ARN) of the access entry.

- `accessEntryName`: string (required) — The name of the access entry.

- `accessEntryRef`: [AccessEntryReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_eks.AccessEntryReference.html) (required) — A reference to a AccessEntry resource.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `addAccessPolicies(newAccessPolicies: IAccessPolicy[]): void` — Add the access policies for this entry.

  **Parameters**

  - `newAccessPolicies` — - The new access policies to add.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromAccessEntryAttributes(scope: Construct, id: string, attrs: AccessEntryAttributes): IAccessEntry` (static) — Imports an `AccessEntry` from its attributes.

  **Parameters**

  - `scope` — - The parent construct.
  - `id` — - The ID of the imported construct.
  - `attrs` — - The attributes of the access entry to import.

  **Returns:** The imported access entry.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.