Interface NginxAddOnProps

Properties available to configure the nginx ingress controller. Values to pass to the chart as per https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#

interface NginxAddOnProps {
    backendProtocol?: string;
    certificateResourceName?: string;
    chart?: string;
    crossZoneEnabled?: boolean;
    dependencyMode?: boolean;
    externalDnsHostname?: string;
    internetFacing?: boolean;
    name?: string;
    namespace?: string;
    release?: string;
    repository?: string;
    skipVersionValidation?: boolean;
    targetType?: string;
    values?: Values;
    version?: string;
}

Hierarchy (view full)

Properties

backendProtocol? certificateResourceName? chart? crossZoneEnabled? dependencyMode? externalDnsHostname? internetFacing? name? namespace? release? repository? skipVersionValidation? targetType? values? version?

Properties

OptionalbackendProtocol

backendProtocol?: string

tcp, http

Default

tcp

OptionalcertificateResourceName

certificateResourceName?: string

Name of the certificate NamedResourceProvider to be used for certificate look up.

See

ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

Optionalchart

chart?: string

Chart name

OptionalcrossZoneEnabled

crossZoneEnabled?: boolean

Enabling cross AZ loadbalancing for

Default

true

OptionaldependencyMode

dependencyMode?: boolean

Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. This value is only used to turn off dependency mode in case customers choose to copy the whole helm chart into their repo

Default

true

OptionalexternalDnsHostname

externalDnsHostname?: string

Used in conjunction with external DNS add-on to handle automatic registration of the service with Route53.

OptionalinternetFacing

internetFacing?: boolean

If the load balancer created for the ingress is internet facing. Internal if set to false.

Default

true

Optionalname

name?: string

Name of the helm chart (add-on)

Optionalnamespace

namespace?: string

Namespace where helm release will be installed

Optionalrelease

release?: string

Helm release

Optionalrepository

repository?: string

Helm repository

OptionalskipVersionValidation

skipVersionValidation?: boolean

When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

OptionaltargetType

targetType?: string

IP or instance mode. Default: IP, requires VPC-CNI, has better performance eliminating a hop through kubeproxy Instance mode: traditional NodePort mode on the instance.

Default

ip

Optionalvalues

values?: Values

Optional values for the helm chart.

Optionalversion

version?: string

Helm chart version.

Settings

Member Visibility

On This Page

Properties