AlbControllerProps Struct
Properties for AlbController.
| Source | aws-eks/lib/alb-controller.ts |
|---|
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
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
additionalHelmChartValues: {
enableWaf: false,
enableWafv2: false,
},
overwriteServiceAccount: false,
policy: policy,
removalPolicy: cdk.RemovalPolicy.DESTROY,
repository: 'repository',
};
# 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"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.eks.*;
AlbControllerVersion albControllerVersion;
Cluster cluster;
Object policy;
AlbControllerProps albControllerProps = AlbControllerProps.builder()
.cluster(cluster)
.version(albControllerVersion)
// the properties below are optional
.additionalHelmChartValues(AlbControllerHelmChartOptions.builder()
.enableWaf(false)
.enableWafv2(false)
.build())
.overwriteServiceAccount(false)
.policy(policy)
.removalPolicy(RemovalPolicy.DESTROY)
.repository("repository")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EKS;
AlbControllerVersion albControllerVersion;
Cluster cluster;
var policy;
var albControllerProps = new AlbControllerProps {
Cluster = cluster,
Version = albControllerVersion,
// the properties below are optional
AdditionalHelmChartValues = new AlbControllerHelmChartOptions {
EnableWaf = false,
EnableWafv2 = false
},
OverwriteServiceAccount = false,
Policy = policy,
RemovalPolicy = RemovalPolicy.DESTROY,
Repository = "repository"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var albControllerVersion AlbControllerVersion
var cluster Cluster
var policy interface{}
albControllerProps := &AlbControllerProps{
Cluster: cluster,
Version: albControllerVersion,
// the properties below are optional
AdditionalHelmChartValues: &AlbControllerHelmChartOptions{
EnableWaf: jsii.Boolean(false),
EnableWafv2: jsii.Boolean(false),
},
OverwriteServiceAccount: jsii.Boolean(false),
Policy: policy,
RemovalPolicy: cdk.RemovalPolicy_DESTROY,
Repository: jsii.String("repository"),
}
Properties
additionalHelmChartValuesoptionalAlbControllerHelmChartOptionsadditional_helm_chart_valuesoptionalAlbControllerHelmChartOptionsadditionalHelmChartValuesoptionalAlbControllerHelmChartOptionsAdditionalHelmChartValuesoptionalAlbControllerHelmChartOptionsAdditionalHelmChartValuesoptionalAlbControllerHelmChartOptions #Default: no additional helm chart values
overwriteServiceAccountoptionalbooleanoverwrite_service_accountoptionalbooloverwriteServiceAccountoptionalBooleanOverwriteServiceAccountoptionalboolOverwriteServiceAccountoptional*bool = false #notes
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.
policyoptionalanypolicyoptionalAnypolicyoptionalObjectPolicyoptionalobjectPolicyoptionalinterface{} #Default: Corresponds to the predefined version.
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).
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy = RemovalPolicy.DESTROY #notes
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
repositoryoptionalstringrepositoryoptionalstrrepositoryoptionalStringRepositoryoptionalstringRepositoryoptional*string #Default: '602401143452.dkr.ecr.us-west-2.amazonaws.com/amazon/aws-load-balancer-controller'
notes
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.
versionAlbControllerVersionversionAlbControllerVersionversionAlbControllerVersionVersionAlbControllerVersionVersionAlbControllerVersion required #