AccessEntry

class aws_cdk.aws_eks.AccessEntry(scope, id, *, access_policies, cluster, principal, access_entry_name=None, access_entry_type=None)

Bases: Resource

Represents an access entry in an Amazon EKS cluster.

An access entry defines the permissions and scope for a user or role to access an Amazon EKS cluster.

Implements:: IAccessEntry
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 = eks.AccessEntry(self, "MyAccessEntry",
    access_policies=[access_policy],
    cluster=cluster,
    principal="principal",

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

Parameters:

scope (Construct) –
id (str) –
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

Methods

add_access_policies(new_access_policies)

Add the access policies for this entry.

Parameters:

new_access_policies (Sequence[IAccessPolicy]) –

The new access policies to add.

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

access_entry_arn: The Amazon Resource Name (ARN) of the access entry.

access_entry_name: The name of the access entry.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_access_entry_attributes(scope, id, *, access_entry_arn, access_entry_name)

Imports an AccessEntry from its attributes.

Parameters:

scope (Construct) –
- The parent construct.
id (str) –
- The ID of the imported construct.
access_entry_arn (str) – The Amazon Resource Name (ARN) of the access entry.
access_entry_name (str) – The name of the access entry.

Return type:

IAccessEntry

Returns:

The imported access entry.

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool