AlbControllerOptions Struct
Options for AlbController.
| Source | aws-eks/lib/alb-controller.ts |
|---|---|
| Type last changed |
Example
import { KubectlV37Layer } from '@aws-cdk/lambda-layer-kubectl-v37';
new eks.Cluster(this, 'HelloEKS', {
version: eks.KubernetesVersion.V1_37,
albController: {
version: eks.AlbControllerVersion.V3_2_2,
overwriteServiceAccount: true
},
kubectlLayer: new KubectlV37Layer(this, 'kubectl'),
});
from aws_cdk.lambda_layer_kubectl_v37 import KubectlV37Layer
eks.Cluster(self, "HelloEKS",
version=eks.KubernetesVersion.V1_37,
alb_controller=eks.AlbControllerOptions(
version=eks.AlbControllerVersion.V3_2_2,
overwrite_service_account=True
),
kubectl_layer=KubectlV37Layer(self, "kubectl")
)
import software.amazon.awscdk.cdk.lambdalayer.kubectl.v37.KubectlV37Layer;
Cluster.Builder.create(this, "HelloEKS")
.version(KubernetesVersion.V1_37)
.albController(AlbControllerOptions.builder()
.version(AlbControllerVersion.V3_2_2)
.overwriteServiceAccount(true)
.build())
.kubectlLayer(new KubectlV37Layer(this, "kubectl"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.LambdaLayer.KubectlV37;
new Cluster(this, "HelloEKS", new ClusterProps {
Version = KubernetesVersion.V1_37,
AlbController = new AlbControllerOptions {
Version = AlbControllerVersion.V3_2_2,
OverwriteServiceAccount = true
},
KubectlLayer = new KubectlV37Layer(this, "kubectl")
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/cdklabs/awscdk-kubectl-go/kubectlv37"
eks.NewCluster(this, jsii.String("HelloEKS"), &ClusterProps{
Version: eks.KubernetesVersion_V1_37(),
AlbController: &AlbControllerOptions{
Version: eks.AlbControllerVersion_V3_2_2(),
OverwriteServiceAccount: jsii.Boolean(true),
},
KubectlLayer: kubectlv37.NewKubectlV37Layer(this, jsii.String("kubectl")),
})
Properties
additionalHelmChartValuesoptionalAlbControllerHelmChartOptionsadditional_helm_chart_valuesoptionalAlbControllerHelmChartOptionsadditionalHelmChartValuesoptionalAlbControllerHelmChartOptionsAdditionalHelmChartValuesoptionalAlbControllerHelmChartOptionsAdditionalHelmChartValuesoptionalAlbControllerHelmChartOptions #Default: no additional helm chart values
overwriteServiceAccountoptionalbooleanoverwrite_service_accountoptionalbooloverwriteServiceAccountoptionalBooleanOverwriteServiceAccountoptionalboolOverwriteServiceAccountoptional*bool = false #notes
If this is set, we will use kubectl apply instead of kubectl create when the ALB controller service account is created. Otherwise, if there is already a service account named 'aws-load-balancer-controller' in the kube-system namespace, the operation will fail.
policyoptionalanypolicyoptionalAnypolicyoptionalObjectPolicyoptionalobjectPolicyoptionalinterface{} #Default: Corresponds to the predefined version.
If you're using one of the built-in versions, this is not required since CDK ships with the appropriate policies for those versions.
However, if you are using a custom version, this is required (and validated).
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy = RemovalPolicy.DESTROY #notes
The removal policy controls what happens to the resources if they stop 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
repositoryoptionalstringrepositoryoptionalstrrepositoryoptionalStringRepositoryoptionalstringRepositoryoptional*string #Default: '602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller'
notes
Note that the default repository works for most regions, but not all. If the repository is not applicable to your region, use a custom repository according to the information here: https://github.com/kubernetes-sigs/aws-load-balancer-controller/releases.
versionAlbControllerVersionversionAlbControllerVersionversionAlbControllerVersionVersionAlbControllerVersionVersionAlbControllerVersion required #