aws-cdk-lib.aws_eks.AlbControllerProps

AlbControllerProps Struct

Properties for AlbController.

AlbControllerProps

extends

• AlbControllerOptions

used as props by

• AlbController

Source

aws-eks/lib/alb-controller.ts

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 albControllerProps: eks.AlbControllerProps = {
  cluster: cluster,
  version: albControllerVersion,

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

Properties

additionalHelmChartValues?optionalAlbControllerHelmChartOptionsadditional_helm_chart_values?optionalAlbControllerHelmChartOptionsadditionalHelmChartValues?optionalAlbControllerHelmChartOptionsAdditionalHelmChartValues?optionalAlbControllerHelmChartOptionsAdditionalHelmChartValues?optionalAlbControllerHelmChartOptions#

Additional helm chart values for ALB controller.

Default: no additional helm chart values

clusterClusterclusterClusterclusterClusterClusterClusterClusterClusterrequired#

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

overwriteServiceAccount?optionalbooleanoverwrite_service_account?optionalbooloverwriteServiceAccount?optionalBooleanOverwriteServiceAccount?optionalboolOverwriteServiceAccount?optional*bool= false#

Overwrite any existing ALB controller service account.

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.

policy?optionalanypolicy?optionalAnypolicy?optionalObjectPolicy?optionalobjectPolicy?optionalinterface{}#

The IAM policy to apply to the service account.

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

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy= RemovalPolicy.DESTROY#

The removal policy applied to the ALB controller resources.

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

repository?optionalstringrepository?optionalstrrepository?optionalStringRepository?optionalstringRepository?optional*string#

The repository to pull the controller image from.

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.

versionAlbControllerVersionversionAlbControllerVersionversionAlbControllerVersionVersionAlbControllerVersionVersionAlbControllerVersionrequired#

Version of the controller.