Class KubectlProviderProps

(experimental) Properties for a KubectlProvider.

Inheritance

object

KubectlProviderProps

Implements

IKubectlProviderProps

IKubectlProviderOptions

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.V2.Alpha

Assembly: Amazon.CDK.AWS.Eks.V2.Alpha.dll

Syntax (csharp)

public class KubectlProviderProps : IKubectlProviderProps, IKubectlProviderOptions

Syntax (vb)

Public Class KubectlProviderProps Implements IKubectlProviderProps, IKubectlProviderOptions

Remarks

Stability: Experimental

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.V2.Alpha;
             using Amazon.CDK;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.IAM;
             using Amazon.CDK.AWS.Lambda;

             Cluster cluster;
             LayerVersion layerVersion;
             Role role;
             SecurityGroup securityGroup;
             Size size;
             Subnet subnet;

             var kubectlProviderProps = new KubectlProviderProps {
                 Cluster = cluster,
                 KubectlLayer = layerVersion,

                 // the properties below are optional
                 AwscliLayer = layerVersion,
                 Environment = new Dictionary<string, string> {
                     { "environmentKey", "environment" }
                 },
                 Memory = size,
                 PrivateSubnets = new [] { subnet },
                 Role = role,
                 SecurityGroup = securityGroup
             };

Synopsis

Constructors

KubectlProviderProps()

(experimental) Properties for a KubectlProvider.

Properties

AwscliLayer	(experimental) An AWS Lambda layer that contains the `aws` CLI.
Cluster	(experimental) The cluster to control.
Environment	(experimental) Custom environment variables when running `kubectl` against this cluster.
KubectlLayer	(experimental) An AWS Lambda layer that includes `kubectl` and `helm`.
Memory	(experimental) The amount of memory allocated to the kubectl provider's lambda function.
PrivateSubnets	(experimental) Subnets to host the `kubectl` compute resources.
Role	(experimental) An IAM role that can perform kubectl operations against this cluster.
SecurityGroup	(experimental) A security group to use for `kubectl` execution.

Constructors

KubectlProviderProps()

(experimental) Properties for a KubectlProvider.

public KubectlProviderProps()

Remarks

Stability: Experimental

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.V2.Alpha;
             using Amazon.CDK;
             using Amazon.CDK.AWS.EC2;
             using Amazon.CDK.AWS.IAM;
             using Amazon.CDK.AWS.Lambda;

             Cluster cluster;
             LayerVersion layerVersion;
             Role role;
             SecurityGroup securityGroup;
             Size size;
             Subnet subnet;

             var kubectlProviderProps = new KubectlProviderProps {
                 Cluster = cluster,
                 KubectlLayer = layerVersion,

                 // the properties below are optional
                 AwscliLayer = layerVersion,
                 Environment = new Dictionary<string, string> {
                     { "environmentKey", "environment" }
                 },
                 Memory = size,
                 PrivateSubnets = new [] { subnet },
                 Role = role,
                 SecurityGroup = securityGroup
             };

Properties

AwscliLayer

(experimental) An AWS Lambda layer that contains the aws CLI.

public ILayerVersion? AwscliLayer { get; set; }

Property Value

ILayerVersion

Remarks

If not defined, a default layer will be used containing the AWS CLI 2.x.

Stability: Experimental

Cluster

(experimental) The cluster to control.

public ICluster Cluster { get; set; }

Property Value

ICluster

Remarks

Stability: Experimental

Environment

(experimental) Custom environment variables when running kubectl against this cluster.

public IDictionary<string, string>? Environment { get; set; }

Property Value

IDictionary<string, string>

Remarks

Stability: Experimental

KubectlLayer

(experimental) An AWS Lambda layer that includes kubectl and helm.

public ILayerVersion KubectlLayer { get; set; }

Property Value

ILayerVersion

Remarks

Stability: Experimental

Memory

(experimental) The amount of memory allocated to the kubectl provider's lambda function.

public Size? Memory { get; set; }

Property Value

Size

Remarks

Stability: Experimental

PrivateSubnets

(experimental) Subnets to host the kubectl compute resources.

public ISubnet[]? PrivateSubnets { get; set; }

Property Value

ISubnet[]

Remarks

If not specified, the k8s endpoint is expected to be accessible publicly.

Stability: Experimental

Role

(experimental) An IAM role that can perform kubectl operations against this cluster.

public IRole? Role { get; set; }

Property Value

IRole

Remarks

The role should be mapped to the system:masters Kubernetes RBAC role.

This role is directly passed to the lambda handler that sends Kube Ctl commands to the cluster.

Default: - if not specified, the default role created by a lambda function will be used.

Stability: Experimental

SecurityGroup

(experimental) A security group to use for kubectl execution.

public ISecurityGroup? SecurityGroup { get; set; }

Property Value

ISecurityGroup

Remarks

Default: - If not specified, the k8s endpoint is expected to be accessible publicly.

Stability: Experimental

Implements

IKubectlProviderProps

IKubectlProviderOptions