KubectlProviderProps Struct
Properties for a KubectlProvider.
Example
ts
// 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
awscliLayerILayerVersionawscli_layerILayerVersionawscliLayerILayerVersionAwscliLayerILayerVersionAwscliLayerILayerVersion= If not defined, a default layer …#An AWS Lambda layer that contains the `aws` CLI.
default
Default: If not defined, a default layer will be used containing the AWS CLI 2.x.
The cluster to control.
environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string= No custom environment variables#Custom environment variables when running `kubectl` against this cluster.
kubectlLayerILayerVersionkubectl_layerILayerVersionkubectlLayerILayerVersionKubectlLayerILayerVersionKubectlLayerILayerVersionrequired#An AWS Lambda layer that includes `kubectl` and `helm`.
The amount of memory allocated to the kubectl provider's lambda function.
privateSubnetsISubnet[]private_subnetstyping.List[ISubnet]privateSubnetsList<ISubnet>PrivateSubnetsISubnet[]PrivateSubnets*[]ISubnet= the k8s is accessible publicly#Subnets to host the `kubectl` compute resources.
If not specified, the k8s endpoint is expected to be accessible publicly.
removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= 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
An IAM role that can perform kubectl operations against this cluster.
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
Default: if not specified, the default role created by a lambda function will be used.
securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup= If not specified, the k8s endpoi…deprecated#Use `securityGroups` instead.
default
Default: If not specified, the k8s endpoint is expected to be accessible publicly.
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= If not specified, the k8s endpoi…#Security groups to use for `kubectl` execution.
default
Default: If not specified, the k8s endpoint is expected to be accessible publicly.