Class KubectlProviderProps
(experimental) Properties for a KubectlProvider.
Inheritance
Namespace: Amazon.CDK.AWS.Eks.V2.Alpha
Assembly: Amazon.CDK.AWS.Eks.V2.Alpha.dll
Syntax (csharp)
public class KubectlProviderProps : Object, IKubectlProviderProps, IKubectlProviderOptionsSyntax (vb)
Public Class KubectlProviderProps
Inherits Object
Implements IKubectlProviderProps, IKubectlProviderOptionsRemarks
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
| Kubectl |
Properties
| Awscli |
(experimental) An AWS Lambda layer that contains the |
| Cluster | (experimental) The cluster to control. |
| Environment | (experimental) Custom environment variables when running |
| Kubectl |
(experimental) An AWS Lambda layer that includes |
| Memory | (experimental) The amount of memory allocated to the kubectl provider's lambda function. |
| Private |
(experimental) Subnets to host the |
| Role | (experimental) An IAM role that can perform kubectl operations against this cluster. |
| Security |
(experimental) A security group to use for |
Constructors
KubectlProviderProps()
public KubectlProviderProps()Properties
AwscliLayer
(experimental) An AWS Lambda layer that contains the aws CLI.
public ILayerVersion AwscliLayer { get; set; }Property Value
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
Remarks
Stability: Experimental
Environment
(experimental) Custom environment variables when running kubectl against this cluster.
public IDictionary<string, string> Environment { get; set; }Property Value
System.
Remarks
Stability: Experimental
KubectlLayer
(experimental) An AWS Lambda layer that includes kubectl and helm.
public ILayerVersion KubectlLayer { get; set; }Property Value
Remarks
Stability: Experimental
Memory
(experimental) The amount of memory allocated to the kubectl provider's lambda function.
public Size Memory { get; set; }Property Value
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
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
Remarks
Default: - If not specified, the k8s endpoint is expected to be accessible publicly.
Stability: Experimental