Class AccessEntryProps

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

Inheritance

object

AccessEntryProps

Implements

IAccessEntryProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EKS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AccessEntryProps : IAccessEntryProps

Syntax (vb)

Public Class AccessEntryProps Implements IAccessEntryProps

Remarks

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;
            using Amazon.CDK.AWS.EKS;

            AccessPolicy accessPolicy;
            Cluster cluster;

            var accessEntryProps = new AccessEntryProps {
                AccessPolicies = new [] { accessPolicy },
                Cluster = cluster,
                Principal = "principal",

                // the properties below are optional
                AccessEntryName = "accessEntryName",
                AccessEntryType = AccessEntryType.STANDARD,
                RemovalPolicy = RemovalPolicy.DESTROY
            };

Synopsis

Constructors

AccessEntryProps()

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

Properties

AccessEntryName	The name of the AccessEntry.
AccessEntryType	The type of the AccessEntry.
AccessPolicies	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.
RemovalPolicy	The removal policy applied to the access entry.

Constructors

AccessEntryProps()

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

public AccessEntryProps()

Remarks

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;
            using Amazon.CDK.AWS.EKS;

            AccessPolicy accessPolicy;
            Cluster cluster;

            var accessEntryProps = new AccessEntryProps {
                AccessPolicies = new [] { accessPolicy },
                Cluster = cluster,
                Principal = "principal",

                // the properties below are optional
                AccessEntryName = "accessEntryName",
                AccessEntryType = AccessEntryType.STANDARD,
                RemovalPolicy = RemovalPolicy.DESTROY
            };

Properties

AccessEntryName

The name of the AccessEntry.

public string? AccessEntryName { get; set; }

Property Value

string

Remarks

Default: - No access entry name is provided

AccessEntryType

The type of the AccessEntry.

public AccessEntryType? AccessEntryType { get; set; }

Property Value

AccessEntryType?

Remarks

Default: STANDARD

AccessPolicies

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

public IAccessPolicy[] AccessPolicies { get; set; }

Property Value

IAccessPolicy[]

Remarks

ExampleMetadata: fixture=_generated

Cluster

The Amazon EKS cluster to which the access entry applies.

public ICluster Cluster { get; set; }

Property Value

ICluster

Remarks

ExampleMetadata: fixture=_generated

Principal

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

public string Principal { get; set; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

RemovalPolicy

The removal policy applied to the access entry.

public RemovalPolicy? RemovalPolicy { get; set; }

Property Value

RemovalPolicy?

Remarks

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

Default: RemovalPolicy.DESTROY

Implements

IAccessEntryProps