AccessEntryProps

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

Bases: object

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

Parameters:

  • access_policies (Sequence[IAccessPolicy]) – (experimental) The access policies that define the permissions and scope for the access entry.

  • cluster (ICluster) – (experimental) The Amazon EKS cluster to which the access entry applies.

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

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

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

  • removal_policy (Optional[RemovalPolicy]) – (experimental) 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

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_eks_v2_alpha as eks_v2_alpha
import aws_cdk as cdk

# access_policy: eks_v2_alpha.AccessPolicy
# cluster: eks_v2_alpha.Cluster

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

    # the properties below are optional
    access_entry_name="accessEntryName",
    access_entry_type=eks_v2_alpha.AccessEntryType.STANDARD,
    removal_policy=cdk.RemovalPolicy.DESTROY
)

Attributes

access_entry_name

(experimental) The name of the AccessEntry.

Default:

  • No access entry name is provided

Stability:

experimental

access_entry_type

(experimental) The type of the AccessEntry.

Default:

STANDARD

Stability:

experimental

access_policies

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

Stability:

experimental

cluster

(experimental) The Amazon EKS cluster to which the access entry applies.

Stability:

experimental

principal

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

Stability:

experimental

removal_policy

(experimental) 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

Stability:

experimental