aws-cdk-lib.aws_eks.AlbControllerProps

interface AlbControllerProps

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

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
  policy: policy,
  repository: 'repository',
};

Properties

NameTypeDescription
clusterCluster[disable-awslint:ref-via-interface] Cluster to install the controller onto.
versionAlbControllerVersionVersion of the controller.
policy?anyThe IAM policy to apply to the service account.
repository?stringThe 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.


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.