interface AlbControllerProps

Language	Type name
.NET	Amazon.CDK.AWS.EKS.AlbControllerProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseks#AlbControllerProps
Java	software.amazon.awscdk.services.eks.AlbControllerProps
Python	aws_cdk.aws_eks.AlbControllerProps
TypeScript (source)	aws-cdk-lib » aws_eks » AlbControllerProps

Implements AlbControllerOptions

Properties for AlbController.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';

declare const albControllerVersion: eks.AlbControllerVersion;
declare const cluster: eks.Cluster;
declare const policy: any;
const albControllerProps: eks.AlbControllerProps = {
  cluster: cluster,
  version: albControllerVersion,

  // the properties below are optional
  additionalHelmChartValues: {
    enableWaf: false,
    enableWafv2: false,
  },
  overwriteServiceAccount: false,
  policy: policy,
  repository: 'repository',
};

Properties

Name	Type	Description
cluster	Cluster	[disable-awslint:ref-via-interface] Cluster to install the controller onto.
version	AlbControllerVersion	Version of the controller.
additionalHelmChartValues?	AlbControllerHelmChartOptions	Additional helm chart values for ALB controller.
overwriteServiceAccount?	boolean	Overwrite any existing ALB controller service account.
policy?	any	The IAM policy to apply to the service account.
repository?	string	The repository to pull the controller image from.

---

cluster

Type: Cluster

[disable-awslint:ref-via-interface] Cluster to install the controller onto.

---

version

Type: AlbControllerVersion

Version of the controller.

---

additionalHelmChartValues?

Type: AlbControllerHelmChartOptions (optional, default: no additional helm chart values)

Additional helm chart values for ALB controller.

---

overwriteServiceAccount?

Type: boolean (optional, default: false)

Overwrite 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.

---

policy?

Type: any (optional, default: Corresponds to the predefined version.)

The 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).

---

repository?

Type: string (optional, default: '602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller')

The 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.