Package software.amazon.awscdk.services.eks

Interface CfnAccessEntryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAccessEntryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:10.552Z")
@Stability(Stable)
public interface CfnAccessEntryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAccessEntry.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 CfnAccessEntryProps cfnAccessEntryProps = CfnAccessEntryProps.builder()
         .clusterName("clusterName")
         .principalArn("principalArn")
         // the properties below are optional
         .accessPolicies(List.of(AccessPolicyProperty.builder()
                 .accessScope(AccessScopeProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .namespaces(List.of("namespaces"))
                         .build())
                 .policyArn("policyArn")
                 .build()))
         .kubernetesGroups(List.of("kubernetesGroups"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .username("username")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAccessEntryProps.Builder	builder()
default Object	getAccessPolicies()	The access policies to associate to the access entry.
String	getClusterName()	The name of your cluster.
default List<String>	getKubernetesGroups()	The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object.
String	getPrincipalArn()	The ARN of the IAM principal for the AccessEntry .
default List<CfnTag>	getTags()	Metadata that assists with categorization and organization.
default String	getType()	The type of the new access entry.
default String	getUsername()	The username to authenticate to Kubernetes with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The name of your cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-clustername

getPrincipalArn

@Stability(Stable)
@NotNull
String getPrincipalArn()

The ARN of the IAM principal for the AccessEntry .

You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.

The valid principals differ depending on the type of the access entry in the type field. For STANDARD access entries, you can use every IAM principal type. For nodes ( EC2 (for EKS Auto Mode), EC2_LINUX , EC2_WINDOWS , FARGATE_LINUX , and HYBRID_LINUX ), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.

IAM best practices recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-principalarn

getAccessPolicies

@Stability(Stable)
@Nullable
default Object getAccessPolicies()

The access policies to associate to the access entry.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-accesspolicies

getKubernetesGroups

@Stability(Stable)
@Nullable
default List<String> getKubernetesGroups()

The value for name that you've specified for kind: Group as a subject in a Kubernetes RoleBinding or ClusterRoleBinding object.

Amazon EKS doesn't confirm that the value for name exists in any bindings on your cluster. You can specify one or more names.

Kubernetes authorizes the principalArn of the access entry to access any cluster objects that you've specified in a Kubernetes Role or ClusterRole object that is also specified in a binding's roleRef . For more information about creating Kubernetes RoleBinding , ClusterRoleBinding , Role , or ClusterRole objects, see Using RBAC Authorization in the Kubernetes documentation .

If you want Amazon EKS to authorize the principalArn (instead of, or in addition to Kubernetes authorizing the principalArn ), you can associate one or more access policies to the access entry using AssociateAccessPolicy . If you associate any access policies, the principalARN has all permissions assigned in the associated access policies and all permissions in any Kubernetes Role or ClusterRole objects that the group names are bound to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-kubernetesgroups

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that assists with categorization and organization.

Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-tags

getType

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

The type of the new access entry.

Valid values are STANDARD , FARGATE_LINUX , EC2_LINUX , EC2_WINDOWS , EC2 (for EKS Auto Mode), HYBRID_LINUX , and HYPERPOD_LINUX .

If the principalArn is for an IAM role that's used for self-managed Amazon EC2 nodes, specify EC2_LINUX or EC2_WINDOWS . Amazon EKS grants the necessary permissions to the node for you. If the principalArn is for any other purpose, specify STANDARD . If you don't specify a value, Amazon EKS sets the value to STANDARD . If you have the access mode of the cluster set to API_AND_CONFIG_MAP , it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the aws-auth ConfigMap for the roles. You can't change this value once you've created the access entry.

If you set the value to EC2_LINUX or EC2_WINDOWS , you can't specify values for kubernetesGroups , or associate an AccessPolicy to the access entry.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-type

getUsername

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

The username to authenticate to Kubernetes with.

We recommend not specifying a username and letting Amazon EKS specify it for you. For more information about the value Amazon EKS specifies for you, or constraints before specifying your own username, see Creating access entries in the Amazon EKS User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-accessentry.html#cfn-eks-accessentry-username

builder

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

Returns:

a CfnAccessEntryProps.Builder of CfnAccessEntryProps