AccessEntryProps

class aws_cdk.aws_eks.AccessEntryProps(*, access_policies, cluster, principal, access_entry_name=None, access_entry_type=None)

Bases: object

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

Parameters:
  • access_policies (Sequence[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 (str) – The Amazon Resource Name (ARN) of the principal (user or role) to associate the access entry with.

  • access_entry_name (Optional[str]) – The name of the AccessEntry. Default: - No access entry name is provided

  • access_entry_type (Optional[AccessEntryType]) – The type of the AccessEntry. Default: STANDARD

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

# access_policy: eks.AccessPolicy
# cluster: eks.Cluster

access_entry_props = eks.AccessEntryProps(
    access_policies=[access_policy],
    cluster=cluster,
    principal="principal",

    # the properties below are optional
    access_entry_name="accessEntryName",
    access_entry_type=eks.AccessEntryType.STANDARD
)

Attributes

access_entry_name

The name of the AccessEntry.

Default:
  • No access entry name is provided

access_entry_type

The type of the AccessEntry.

Default:

STANDARD

access_policies

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

cluster

The Amazon EKS cluster to which the access entry applies.

principal

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