AlbControllerProps

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

Bases: AlbControllerOptions

(experimental) Properties for AlbController.

Parameters:

  • version (AlbControllerVersion) – (experimental) Version of the controller.

  • additional_helm_chart_values (Optional[Mapping[str, Any]]) – (experimental) Additional helm chart values for ALB controller. For available options, see: https://github.com/kubernetes-sigs/aws-load-balancer-controller/blob/main/helm/aws-load-balancer-controller/values.yaml Default: - no additional helm chart values

  • overwrite_service_account (Optional[bool]) – (experimental) 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) – (experimental) 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.

  • repository (Optional[str]) – (experimental) 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) – (experimental) [disable-awslint:ref-via-interface] Cluster to install the controller onto.

Stability:

experimental

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.aws_eks_v2_alpha as eks_v2_alpha

# additional_helm_chart_values: Any
# alb_controller_version: eks_v2_alpha.AlbControllerVersion
# cluster: eks_v2_alpha.Cluster
# policy: Any

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

    # the properties below are optional
    additional_helm_chart_values={
        "additional_helm_chart_values_key": additional_helm_chart_values
    },
    overwrite_service_account=False,
    policy=policy,
    repository="repository"
)

Attributes

additional_helm_chart_values

(experimental) Additional helm chart values for ALB controller.

For available options, see: https://github.com/kubernetes-sigs/aws-load-balancer-controller/blob/main/helm/aws-load-balancer-controller/values.yaml

Default:

  • no additional helm chart values

Stability:

experimental

cluster

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

Stability:

experimental

Type:

(experimental) [disable-awslint

overwrite_service_account

(experimental) 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

Stability:

experimental

policy

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

Stability:

experimental

repository

(experimental) 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’

Stability:

experimental

version

(experimental) Version of the controller.

Stability:

experimental