Class AccessEntry

Represents an access entry in an Amazon EKS cluster.

Inheritance

object

Resource

AccessEntry

Implements

IAccessEntry

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.EKS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AccessEntry : Resource, IAccessEntry, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class AccessEntry Inherits Resource Implements IAccessEntry, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             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
             });

Synopsis

Constructors

AccessEntry(Construct, string, IAccessEntryProps)

Represents an access entry in an Amazon EKS cluster.

Properties

AccessEntryArn	The Amazon Resource Name (ARN) of the access entry.
AccessEntryName	The name of the access entry.
PROPERTY_INJECTION_ID	Uniquely identifies this class.

Methods

AddAccessPolicies(IAccessPolicy[])	Add the access policies for this entry.
FromAccessEntryAttributes(Construct, string, IAccessEntryAttributes)	Imports an `AccessEntry` from its attributes.

Constructors

AccessEntry(Construct, string, IAccessEntryProps)

Represents an access entry in an Amazon EKS cluster.

public AccessEntry(Construct scope, string id, IAccessEntryProps props)

Parameters

scope Construct
id string
props IAccessEntryProps

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             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
             });

Properties

AccessEntryArn

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

public virtual string AccessEntryArn { get; }

Property Value

string

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

AccessEntryName

The name of the access entry.

public virtual string AccessEntryName { get; }

Property Value

string

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

Methods

AddAccessPolicies(IAccessPolicy[])

Add the access policies for this entry.

public virtual void AddAccessPolicies(IAccessPolicy[] newAccessPolicies)

Parameters

newAccessPolicies IAccessPolicy[]

The new access policies to add.

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

FromAccessEntryAttributes(Construct, string, IAccessEntryAttributes)

Imports an AccessEntry from its attributes.

public static IAccessEntry FromAccessEntryAttributes(Construct scope, string id, IAccessEntryAttributes attrs)

Parameters

scope Construct

The parent construct.

id string

The ID of the imported construct.

attrs IAccessEntryAttributes

The attributes of the access entry to import.

Returns

IAccessEntry

The imported access entry.

Remarks

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

Implements: IAccessEntry

ExampleMetadata: fixture=_generated

Implements

IAccessEntry

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware