AlbController

class aws_cdk.aws_eks.AlbController(scope, id, *, cluster, version, policy=None, repository=None)

Bases: Construct

Construct for installing the AWS ALB Contoller on EKS clusters.

Use the factory functions get and getOrCreate to obtain/create instances of this controller.

See:: https://kubernetes-sigs.github.io/aws-load-balancer-controller
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 as eks

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

alb_controller = eks.AlbController(self, "MyAlbController",
    cluster=cluster,
    version=alb_controller_version,

    # the properties below are optional
    policy=policy,
    repository="repository"
)

Parameters:

scope (Construct)
id (str)
cluster (Cluster) – [disable-awslint:ref-via-interface] Cluster to install the controller onto.
version (AlbControllerVersion) – Version of the controller.
policy (Optional[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.
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’

Methods

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

node: The construct tree node associated with this construct.

Static Methods

classmethod create(scope, *, cluster, version, policy=None, repository=None)

Create the controller construct associated with this cluster and scope.

Singleton per stack/cluster.

Parameters:

scope (Construct)
cluster (Cluster) – [disable-awslint:ref-via-interface] Cluster to install the controller onto.
version (AlbControllerVersion) – Version of the controller.
policy (Optional[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.
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’

Return type:

AlbController

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool