@aws-quickstart/eks-blueprints
    Preparing search index...

    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 Summary)

    Index

    Properties

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

    Properties

    backendProtocol?: string

    tcp, http

    tcp
    certificateResourceName?: string

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

    ImportCertificateProvider and CreateCertificateProvider for examples of certificate providers.

    chart?: string

    Chart name

    crossZoneEnabled?: boolean

    Enabling cross AZ loadbalancing for

    true
    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

    true
    externalDnsHostname?: string

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

    internetFacing?: boolean

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

    true
    name?: string

    Name of the helm chart (add-on)

    namespace?: string

    Namespace where helm release will be installed

    release?: string

    Helm release

    repository?: string

    Helm repository

    skipVersionValidation?: boolean

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

    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.

    ip
    values?: Values

    Optional values for the helm chart.

    version?: string

    Helm chart version.

    Settings

    Member Visibility

    On This Page

    Properties