Package software.amazon.awscdk.services.eks_v2

Interface AccessEntryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AccessEntryProps.Jsii$Proxy

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

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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.eks_v2.*;
 AccessPolicy accessPolicy;
 Cluster cluster;
 AccessEntryProps accessEntryProps = AccessEntryProps.builder()
         .accessPolicies(List.of(accessPolicy))
         .cluster(cluster)
         .principal("principal")
         // the properties below are optional
         .accessEntryName("accessEntryName")
         .accessEntryType(AccessEntryType.STANDARD)
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AccessEntryProps.Builder	builder()
default String	getAccessEntryName()	The name of the AccessEntry.
default AccessEntryType	getAccessEntryType()	The type of the AccessEntry.
List<IAccessPolicy>	getAccessPolicies()	The access policies that define the permissions and scope for the access entry.
ICluster	getCluster()	The Amazon EKS cluster to which the access entry applies.
String	getPrincipal()	The Amazon Resource Name (ARN) of the principal (user or role) to associate the access entry with.
default RemovalPolicy	getRemovalPolicy()	The removal policy applied to the access entry.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessPolicies

@Stability(Stable)
@NotNull
List<IAccessPolicy> getAccessPolicies()

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

getCluster

@Stability(Stable)
@NotNull
ICluster getCluster()

The Amazon EKS cluster to which the access entry applies.

getPrincipal

@Stability(Stable)
@NotNull
String getPrincipal()

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

getAccessEntryName

@Stability(Stable)
@Nullable
default String getAccessEntryName()

The name of the AccessEntry.

Default: - No access entry name is provided

getAccessEntryType

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

The type of the AccessEntry.

Default: STANDARD

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy applied to the access entry.

The removal policy controls what happens to the resources if they stop 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

builder

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

Returns:

a AccessEntryProps.Builder of AccessEntryProps