aws-cdk-lib.aws_eks_v2.KubectlProviderProps

KubectlProviderProps Struct

Properties for a KubectlProvider.

KubectlProviderProps

extends

• KubectlProviderOptions

used as props by

• KubectlProvider

Source

aws-eks-v2/lib/kubectl-provider.ts

Type last changed

v2.240.0 · 23 Feb 2026

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_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_eks_v2 as eks_v2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';

declare const cluster: eks_v2.Cluster;
declare const layerVersion: lambda.LayerVersion;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const size: cdk.Size;
declare const subnet: ec2.Subnet;
const kubectlProviderProps: eks_v2.KubectlProviderProps = {
  cluster: cluster,
  kubectlLayer: layerVersion,

  // the properties below are optional
  awscliLayer: layerVersion,
  environment: {
    environmentKey: 'environment',
  },
  memory: size,
  privateSubnets: [subnet],
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  role: role,
  securityGroup: securityGroup,
  securityGroups: [securityGroup],
};

Properties

awscliLayer?optionalILayerVersionawscli_layer?optionalILayerVersionawscliLayer?optionalILayerVersionAwscliLayer?optionalILayerVersionAwscliLayer?optionalILayerVersion#

An AWS Lambda layer that contains the `aws` CLI.

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

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The cluster to control.

environment?optional{ [key: string]: string }environment?optionaltyping.Mapping[str, str]environment?optionalMap<String, String>Environment?optionalIDictionary<string, string>Environment?optional*map[string]*string#

Custom environment variables when running `kubectl` against this cluster.

Default: No custom environment variables

kubectlLayerILayerVersionkubectl_layerILayerVersionkubectlLayerILayerVersionKubectlLayerILayerVersionKubectlLayerILayerVersionrequired#

An AWS Lambda layer that includes `kubectl` and `helm`.

memory?optionalSizememory?optionalSizememory?optionalSizeMemory?optionalSizeMemory?optionalSize= 1024#

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

privateSubnets?optionalISubnet[]private_subnets?optionaltyping.List[ISubnet]privateSubnets?optionalList<ISubnet>PrivateSubnets?optionalISubnet[]PrivateSubnets?optional*[]ISubnet#

Subnets to host the `kubectl` compute resources.

Default: the k8s is accessible publicly

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

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy= RemovalPolicy.DESTROY#

The removal policy applied to the custom resource that provides kubectl.

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

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

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

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

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.

securityGroup?optionalISecurityGroupsecurity_group?optionalISecurityGroupsecurityGroup?optionalISecurityGroupSecurityGroup?optionalISecurityGroupSecurityGroup?optionalISecurityGroupdeprecated#

Use `securityGroups` instead.

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

securityGroups?optionalISecurityGroup[]security_groups?optionaltyping.List[ISecurityGroup]securityGroups?optionalList<ISecurityGroup>SecurityGroups?optionalISecurityGroup[]SecurityGroups?optional*[]ISecurityGroup#

Security groups to use for `kubectl` execution.

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