2.238.0

interface AlbControllerOptions

LanguageType name
.NETAmazon.CDK.AWS.EKS.AlbControllerOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#AlbControllerOptions
Javasoftware.amazon.awscdk.services.eks.AlbControllerOptions
Pythonaws_cdk.aws_eks.AlbControllerOptions
TypeScript (source)aws-cdk-lib » aws_eks » AlbControllerOptions

Options for AlbController.

Example

import { KubectlV34Layer } from '@aws-cdk/lambda-layer-kubectl-v34';

new eks.Cluster(this, 'HelloEKS', {
  version: eks.KubernetesVersion.V1_34,
  albController: {
    version: eks.AlbControllerVersion.V2_8_2,
    overwriteServiceAccount: true
  },
  kubectlLayer: new KubectlV34Layer(this, 'kubectl'),
});

Properties

NameTypeDescription
versionAlbControllerVersionVersion of the controller.
additionalHelmChartValues?AlbControllerHelmChartOptionsAdditional helm chart values for ALB controller.
overwriteServiceAccount?booleanOverwrite any existing ALB controller service account.
policy?anyThe IAM policy to apply to the service account.
removalPolicy?RemovalPolicyThe removal policy applied to the ALB controller resources.
repository?stringThe repository to pull the controller image from.

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.

← PreviousNext →