AlbControllerProps

class aws_cdk.aws_eks.AlbControllerProps(*, version, additional_helm_chart_values=None, overwrite_service_account=None, policy=None, removal_policy=None, repository=None, cluster)

Bases: AlbControllerOptions

Properties for AlbController.

Parameters:

version (AlbControllerVersion) – Version of the controller.
additional_helm_chart_values (Union[AlbControllerHelmChartOptions, Dict[str, Any], None]) – Additional helm chart values for ALB controller. Default: - no additional helm chart values
overwrite_service_account (Optional[bool]) – 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. Default: false
policy (Any) – 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). Default: - Corresponds to the predefined version.
removal_policy (Optional[RemovalPolicy]) – 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 Default: RemovalPolicy.DESTROY
repository (Optional[str]) – 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. Default: ‘602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller’
cluster (Cluster) – [disable-awslint:ref-via-interface] Cluster to install the controller onto.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_eks as eks

# alb_controller_version: eks.AlbControllerVersion
# cluster: eks.Cluster
# policy: Any

alb_controller_props = eks.AlbControllerProps(
    cluster=cluster,
    version=alb_controller_version,

    # the properties below are optional
    additional_helm_chart_values=eks.AlbControllerHelmChartOptions(
        enable_waf=False,
        enable_wafv2=False
    ),
    overwrite_service_account=False,
    policy=policy,
    removal_policy=cdk.RemovalPolicy.DESTROY,
    repository="repository"
)

Attributes

additional_helm_chart_values

Additional helm chart values for ALB controller.

Default:

no additional helm chart values

cluster

ref-via-interface] Cluster to install the controller onto.

Type:: [disable-awslint

overwrite_service_account

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.

Default:: false

policy

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

Default:

Corresponds to the predefined version.

removal_policy

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

Default:: RemovalPolicy.DESTROY

repository

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.

Default:: ‘602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller’

version: Version of the controller.