AlbController
Construct for installing the AWS ALB Contoller on EKS clusters. Use the factory functions `get` and `getOrCreate` to obtain/create instances of this controller.
Import
import { AlbController } from 'aws-cdk-lib/aws-eks';Or use the module namespace:
import * as eks from 'aws-cdk-lib/aws-eks';
// eks.AlbControllerProperties
Configuration passed to the constructor as AlbControllerProps.
clusterRequiredCluster[disable-awslint:ref-via-interface] Cluster to install the controller onto.
6 properties inherited from AlbControllerOptions
versionRequiredinherited from AlbControllerOptionsAlbControllerVersionVersion of the controller.
additionalHelmChartValuesOptionalinherited from AlbControllerOptionsAlbControllerHelmChartOptionsAdditional helm chart values for ALB controller.
Default: - no additional helm chart values
overwriteServiceAccountOptionalinherited from AlbControllerOptionsbooleanOverwrite any existing ALB controller service account. 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.
Default: false
policyOptionalinherited from AlbControllerOptionsanyThe IAM policy to apply to the service account. 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).
Default: - Corresponds to the predefined version.
removalPolicyOptionalinherited from AlbControllerOptionsRemovalPolicyThe removal policy applied to the ALB controller resources. 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
Default: RemovalPolicy.DESTROY
repositoryOptionalinherited from AlbControllerOptionsstringThe repository to pull the controller image from. 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.
Default: '602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller'
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-eks