Interface IngressNginxAddOnProps

Properties available to configure the nginx ingress controller. Values to pass to the chart as per https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/

interface IngressNginxAddOnProps {
    backendProtocol?: string;
    certificateResourceARN?: string;
    certificateResourceName?: string;
    chart?: string;
    controllerClass?: string;
    crossZoneEnabled?: boolean;
    dependencyMode?: boolean;
    electionId?: string;
    externalDnsHostname?: string;
    forceSSLRedirect?: boolean;
    httpTargetPort?: string;
    httpsTargetPort?: string;
    idleTimeout?: string;
    ingressClassName?: string;
    internetFacing?: boolean;
    isDefaultClass?: boolean;
    loadBalancerType?: string;
    name?: string;
    namespace?: string;
    release?: string;
    repository?: string;
    serviceType?: string;
    skipVersionValidation?: boolean;
    sslPort?: string;
    targetType?: string;
    values?: Values;
    version?: string;
}

Hierarchy (view full)

Properties

backendProtocol? certificateResourceARN? certificateResourceName? chart? controllerClass? crossZoneEnabled? dependencyMode? electionId? externalDnsHostname? forceSSLRedirect? httpTargetPort? httpsTargetPort? idleTimeout? ingressClassName? internetFacing? isDefaultClass? loadBalancerType? name? namespace? release? repository? serviceType? skipVersionValidation? sslPort? targetType? values? version?

Properties

OptionalbackendProtocol

backendProtocol?: string

Specifies the protocol used by the load balancer. HTTP, HTTPS, AUTO_HTTP, GRPC, GRPCS, and FCGI are supported.

Default

'http'

OptionalcertificateResourceARN

certificateResourceARN?: string

ARN of the AWS Certificate Manager certificate to be used for HTTPS.

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

The name of the chart within the Helm release.

OptionalcontrollerClass

controllerClass?: string

Specifies the controller class used for handling ingress in a cluster.

OptionalcrossZoneEnabled

crossZoneEnabled?: boolean

Determines whether cross-zone load balancing is enabled for the load balancer.

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

OptionalelectionId

electionId?: string

Identifier used for leader election during the deployment of multiple ingress controllers.

OptionalexternalDnsHostname

externalDnsHostname?: string

Hostname to be used with external DNS services for automatic DNS configuration.

OptionalforceSSLRedirect

forceSSLRedirect?: boolean

Determines if SSL redirection should be forced.

Default

true

OptionalhttpTargetPort

httpTargetPort?: string

Protocol for the load balancer HTTP target port.

Default

'http'

OptionalhttpsTargetPort

httpsTargetPort?: string

Protocol for the load balancer HTTPS target port.

Default

'https'

OptionalidleTimeout

idleTimeout?: string

ARN of the AWS Certificate Manager certificate to be used for HTTPS.

Default

"3600"

OptionalingressClassName

ingressClassName?: string

Specifies the class of the ingress controller. Used to differentiate between multiple ingress controllers.

Default

'nginx'

OptionalinternetFacing

internetFacing?: boolean

Indicates whether the load balancer is exposed to the internet. Set to false for an internal load balancer.

Default

true

OptionalisDefaultClass

isDefaultClass?: boolean

Determines if the ingress controller should be set as the default controller for handling ingress resources.

Default

false

OptionalloadBalancerType

loadBalancerType?: string

Type of the load balancer.

Default

'external'

Optionalname

name?: string

The name of the Kubernetes Ingress Helm release.

Optionalnamespace

namespace?: string

Kubernetes namespace where the ingress controller will be installed.

Default

'kube-system'

Optionalrelease

release?: string

Unique identifier for the release.

Optionalrepository

repository?: string

URL of the chart repository.

OptionalserviceType

serviceType?: string

Kubernetes service type for the ingress controller. Supported values are 'ClusterIP', 'LoadBalancer' and 'NodePort'.

Default

'LoadBalancer'

OptionalskipVersionValidation

skipVersionValidation?: boolean

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

OptionalsslPort

sslPort?: string

Protocol for the load balancer SSL port.

Default

'https'

OptionaltargetType

targetType?: string

Specifies how traffic is routed to pods. Can be either 'ip' or 'instance'. 'ip' mode is more performant and requires VPC-CNI.

Default

'ip'

Optionalvalues

values?: Values

Custom values passed to the Helm chart.

Optionalversion

version?: string

Specific version of the chart to be deployed.

Settings

Member Visibility

On This Page

Properties