interface AccessEntryProps

Language	Type name
.NET	Amazon.CDK.AWS.EKS.AccessEntryProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseks#AccessEntryProps
Java	software.amazon.awscdk.services.eks.AccessEntryProps
Python	aws_cdk.aws_eks.AccessEntryProps
TypeScript (source)	aws-cdk-lib » aws_eks » AccessEntryProps

Represents the properties required to create an Amazon EKS access entry.

Example

// 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 accessEntryProps: eks.AccessEntryProps = {
  accessPolicies: [accessPolicy],
  cluster: cluster,
  principal: 'principal',

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

Properties

Name	Type	Description
accessPolicies	IAccessPolicy[]	The access policies that define the permissions and scope for the access entry.
cluster	ICluster	The Amazon EKS cluster to which the access entry applies.
principal	string	The Amazon Resource Name (ARN) of the principal (user or role) to associate the access entry with.
accessEntryName?	string	The name of the AccessEntry.
accessEntryType?	AccessEntryType	The type of the AccessEntry.
removalPolicy?	RemovalPolicy	The removal policy applied to the access entry.

---

accessPolicies

Type: IAccessPolicy[]

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

---

cluster

Type: ICluster

The Amazon EKS cluster to which the access entry applies.

---

principal

Type: string

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

---

accessEntryName?

Type: string (optional, default: No access entry name is provided)

The name of the AccessEntry.

---

accessEntryType?

Type: AccessEntryType (optional, default: STANDARD)

The type of the AccessEntry.

---

removalPolicy?

Type: RemovalPolicy (optional, default: 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