AccessEntry L2 construct
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_eks as eks } from 'aws-cdk-lib';
declare const accessPolicy: eks.AccessPolicy;
declare const cluster: eks.Cluster;
const accessEntry = new eks.AccessEntry(this, 'MyAccessEntry', {
accessPolicies: [accessPolicy],
cluster: cluster,
principal: 'principal',
// the properties below are optional
accessEntryName: 'accessEntryName',
accessEntryType: eks.AccessEntryType.STANDARD,
removalPolicy: cdk.RemovalPolicy.DESTROY,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
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,
removal_policy=cdk.RemovalPolicy.DESTROY
)
// 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.*;
AccessPolicy accessPolicy;
Cluster cluster;
AccessEntry accessEntry = AccessEntry.Builder.create(this, "MyAccessEntry")
.accessPolicies(List.of(accessPolicy))
.cluster(cluster)
.principal("principal")
// the properties below are optional
.accessEntryName("accessEntryName")
.accessEntryType(AccessEntryType.STANDARD)
.removalPolicy(RemovalPolicy.DESTROY)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EKS;
AccessPolicy accessPolicy;
Cluster cluster;
var accessEntry = new AccessEntry(this, "MyAccessEntry", new AccessEntryProps {
AccessPolicies = new [] { accessPolicy },
Cluster = cluster,
Principal = "principal",
// the properties below are optional
AccessEntryName = "accessEntryName",
AccessEntryType = AccessEntryType.STANDARD,
RemovalPolicy = RemovalPolicy.DESTROY
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var accessPolicy AccessPolicy
var cluster Cluster
accessEntry := awscdk.Aws_eks.NewAccessEntry(this, jsii.String("MyAccessEntry"), &AccessEntryProps{
AccessPolicies: []IAccessPolicy{
accessPolicy,
},
Cluster: cluster,
Principal: jsii.String("principal"),
// the properties below are optional
AccessEntryName: jsii.String("accessEntryName"),
AccessEntryType: awscdk.*Aws_eks.AccessEntryType_STANDARD,
RemovalPolicy: cdk.RemovalPolicy_DESTROY,
})
Initializer
new AccessEntry(scope: Construct, id: string, props: AccessEntryProps)
AccessEntry(scope: Construct, id: str, props: AccessEntryProps)
new AccessEntry(Construct scope, String id, AccessEntryProps props)
new AccessEntry(Construct scope, string id, AccessEntryProps props)
NewAccessEntry(Scope Construct, Id *string, Props AccessEntryProps)
Construct Props
accessEntryNamestringaccess_entry_namestraccessEntryNameStringAccessEntryNamestringAccessEntryName*string= No access entry name is provided#accessEntryTypeAccessEntryTypeaccess_entry_typeAccessEntryTypeaccessEntryTypeAccessEntryTypeAccessEntryTypeAccessEntryTypeAccessEntryTypeAccessEntryType= STANDARD#accessPoliciesIAccessPolicy[]access_policiestyping.List[IAccessPolicy]accessPoliciesList<IAccessPolicy>AccessPoliciesIAccessPolicy[]AccessPolicies*[]IAccessPolicyrequired#removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.DESTROY#notes
The removal policy controls what happens to the resource if it stops 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
Properties
accessEntryArnstringaccess_entry_arnstraccessEntryArnStringAccessEntryArnstringAccessEntryArn*stringrequired#accessEntryNamestringaccess_entry_namestraccessEntryNameStringAccessEntryNamestringAccessEntryName*stringrequired#accessEntryRefAccessEntryReferenceaccess_entry_refAccessEntryReferenceaccessEntryRefAccessEntryReferenceAccessEntryRefAccessEntryReferenceAccessEntryRefAccessEntryReferencerequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
addAccessPolicies(newAccessPolicies: IAccessPolicy[]): voiddef add_access_policies(self, new_access_policies: typing.List[IAccessPolicy]) -> Nonepublic void addAccessPolicies(List<IAccessPolicy> newAccessPolicies)public void AddAccessPolicies(IAccessPolicy[] newAccessPolicies)func AddAccessPolicies(NewAccessPolicies *[]IAccessPolicy)#1 parameter
Parameters
newAccessPoliciesnew_access_policiesnewAccessPoliciesnewAccessPoliciesNewAccessPolicies— - The new access policies to add.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromAccessEntryAttributes(scope: Construct, id: string, attrs: AccessEntryAttributes): IAccessEntry@staticmethod def from_access_entry_attributes(scope: Construct, id: str, attrs: AccessEntryAttributes) -> IAccessEntrypublic static IAccessEntry fromAccessEntryAttributes(Construct scope, String id, AccessEntryAttributes attrs)public static IAccessEntry FromAccessEntryAttributes(Construct scope, string id, AccessEntryAttributes attrs)func FromAccessEntryAttributes(Scope Construct, Id *string, Attrs AccessEntryAttributes) IAccessEntrystatic#3 parameters · returns
Parameters
scopescopescopescopeScope— - The parent construct.ididididId— - The ID of the imported construct.attrsattrsattrsattrsAttrs— - The attributes of the access entry to import.
Returns: The imported access entry.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.