API.md

API Reference

Constructs

AlbIngressController

Generate alb-ingress-controller config yaml.

see https://github.com/kubernetes-sigs/aws-alb-ingress-controller/blob/master/docs/examples

Initializers

import { AlbIngressController } from 'cdk8s-aws-load-balancer-controller'

new AlbIngressController(scope: Construct, id: string, options: AlbIngressControllerOptions)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

options^Required

• Type: cdk8s-aws-load-balancer-controller.AlbIngressControllerOptions

---

Properties

clusterName^Required

• Type: string

Kubernetes Cluster Name for alb-ingress-controller.

---

deploymentName^Required

• Type: string

Kubernetes Deployment Name for alb-ingress-controller.

---

namespace^Required

• Type: string
• Default: kube-system

Namespace for alb-ingress-controller.

---

serviceAccountName^Required

• Type: string

Service Account Name for alb-ingress-controller.

---

AwsLoadBalancerController

Generate aws-load-balancer-controller config yaml.

see https://github.com/kubernetes-sigs/aws-aws-load-balancer-controller/blob/master/docs/install/v2_0_0_full.yaml

Initializers

import { AwsLoadBalancerController } from 'cdk8s-aws-load-balancer-controller'

new AwsLoadBalancerController(scope: Construct, id: string, options: AwsLoadBalancerControllerOptions)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

options^Required

• Type: cdk8s-aws-load-balancer-controller.AwsLoadBalancerControllerOptions

---

Properties

chartVersion^Required

• Type: string
• Default: latest Helm Chart version.

Helm Chart Version for aws-load-balancer-controller.

---

clusterName^Required

• Type: string

Kubernetes Cluster Name for aws-load-balancer-controller.

---

deploymentName^Required

• Type: string

Kubernetes Deployment Name for aws-load-balancer-controller.

---

namespace^Required

• Type: string
• Default: default

Namespace for aws-load-balancer-controller.

---

serviceAccountName^Required

• Type: string

Service Account Name for aws-load-balancer-controller.

---

Structs

AlbIngressControllerOptions

Initializer

import { AlbIngressControllerOptions } from 'cdk8s-aws-load-balancer-controller'

const albIngressControllerOptions: AlbIngressControllerOptions = { ... }

clusterName^Required

• Type: string
• Default: None

Kubernetes Cluster Name for alb-ingress-controller.

---

args^Optional

• Type: string[]
• Default: None

Another Args for alb-ingress-controller.

---

env^Optional

• Type: cdk8s-aws-load-balancer-controller.EnvVar[]
• Default: None

Another Args for alb-ingress-controller.

---

image^Optional

• Type: string
• Default: docker.io/amazon/aws-alb-ingress-controller:v1.1.9

Default image for alb-ingress-controller.

---

labels^Optional

• Type: {[ key: string ]: string}
• Default: none

Extra labels to associate with resources.

---

namespace^Optional

• Type: string
• Default: kube-system

Default Namespace for alb-ingress-controller.

---

replicas^Optional

• Type: number
• Default: 1

Replicas for alb-ingress-controller.

---

serviceAccountName^Optional

• Type: string
• Default: alb-ingress-controller

Default Service Account Name for alb-ingress-controller.

---

AwsLoadBalancerControllerOptions

Initializer

import { AwsLoadBalancerControllerOptions } from 'cdk8s-aws-load-balancer-controller'

const awsLoadBalancerControllerOptions: AwsLoadBalancerControllerOptions = { ... }

clusterName^Required

• Type: string
• Default: None

Kubernetes Cluster Name for aws-load-balancer-controller.

---

chartVersion^Optional

• Type: string
• Default: latest Helm Chart version.

Helm Chart Version for aws-load-balancer-controller.

---

createServiceAccount^Optional

• Type: boolean
• Default: true

service account for aws-load-balancer-controller.

---

namespace^Optional

• Type: string
• Default: default

Namespace for aws-load-balancer-controller.

---

EnvVar

Initializer

import { EnvVar } from 'cdk8s-aws-load-balancer-controller'

const envVar: EnvVar = { ... }

name^Required

• Type: string

Name of the environment variable.

Must be a C_IDENTIFIER.

---

value^Optional

• Type: string
• Default: .

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables.

If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

---

Classes

AwsLoadBalancePolicy

awsLoadBalancePolicy class ,help you add policy to your Iam Role for service account.

Initializers

import { AwsLoadBalancePolicy } from 'cdk8s-aws-load-balancer-controller'

new AwsLoadBalancePolicy()

Static Functions

addPolicy

import { AwsLoadBalancePolicy } from 'cdk8s-aws-load-balancer-controller'

AwsLoadBalancePolicy.addPolicy(version: string, role: any)

version^Required

• Type: string

---

role^Required

• Type: any

---

CertManager

Initializers

import { CertManager } from 'cdk8s-aws-load-balancer-controller'

new CertManager()

Static Functions

certManagerConfig

import { CertManager } from 'cdk8s-aws-load-balancer-controller'

CertManager.certManagerConfig()

Enums

VersionsLists

AWS_LOAD_BALANCER_CONTROLLER_POLICY_V1

---

AWS_LOAD_BALANCER_CONTROLLER_POLICY_V2

---