class AlbController (construct)

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

Implements IConstruct, IDependable

Construct for installing the AWS ALB Contoller on EKS clusters.

Use the factory functions get and getOrCreate to obtain/create instances of this controller.

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_eks as eks } from 'aws-cdk-lib';

declare const albControllerVersion: eks.AlbControllerVersion;
declare const cluster: eks.Cluster;
declare const policy: any;
const albController = new eks.AlbController(this, 'MyAlbController', {
  cluster: cluster,
  version: albControllerVersion,

  // the properties below are optional
  additionalHelmChartValues: {
    enableWaf: false,
    enableWafv2: false,
  },
  overwriteServiceAccount: false,
  policy: policy,
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  repository: 'repository',
});

Initializer

new AlbController(scope: Construct, id: string, props: AlbControllerProps)

Parameters

scope Construct
id string
props AlbControllerProps

Construct Props

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.
removalPolicy?	`RemovalPolicy`	The removal policy applied to the ALB controller resources.
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).

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

The 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

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.

Properties

Name	Type	Description
node	`Node`	The tree node.

node

Type: Node

The tree node.

Methods

Name	Description
toString()	Returns a string representation of this construct.
static create(scope, props)	Create the controller construct associated with this cluster and scope.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

static create(scope, props)

public static create(scope: Construct, props: AlbControllerProps): AlbController