@aws-accelerator/config
    Preparing search index...

    Interface IAlbListenerConfig

    CustomizationsConfig / AppConfigItem / ApplicationLoadBalancerConfig / ApplicationLoadBalancerListenerConfig

    Application Load Balancer listener config. Currently only action type of forward, redirect and fixed-response is allowed.

    https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_CreateListener.html

     - name: appA-listener-0
       port: 80
       protocol: HTTP
       targetGroup: appA-alb-tg-0
       order: 1
       type: forward
       forwardConfig:
         targetGroupStickinessConfig:
           durationSeconds: 1000
           enabled: true
     - name: appA-listener-1
       port: 80
       protocol: HTTP
       targetGroup: appA-alb-tg-1
       order: 4
       type: fixed-response
       fixedResponseConfig:
         statusCode: '200'
         contentType: text/plain
         messageBody: 'Hello World'
    - name: appA-listener-2
       port: 80
       protocol: HTTP
       targetGroup: appA-alb-tg-2
       order: 2
       type: redirect
       redirectConfig:
         statusCode: HTTP_301
         host: '#{host}'
         path: '/#{path}'
         port: 443
         protocol: HTTPS
         query: '#{query}'
    - name: appA-listener-3
       port: 443
       protocol: HTTPS
       targetGroup: appA-alb-tg-3
       order: 3
       type: forward
       certificate: 'arn:aws:acm:some-valid-region:111111111111:certificate/valid-certificate-hash'
       sslPolicy: ELBSecurityPolicy-2016-08
    interface IAlbListenerConfig {
        name: string;
        port: number;
        protocol: AlbListenerProtocolEnum;
        type: AlbListenerTypeEnum;
        certificate?: string;
        sslPolicy?: SslPolicyAlbEnum;
        targetGroup: string;
        fixedResponseConfig?: IAlbListenerFixedResponseConfig;
        forwardConfig?: IAlbListenerForwardConfig;
        order?: number;
        redirectConfig?: IAlbListenerRedirectConfig;
    }
    Index

    Properties

    name port protocol type certificate? sslPolicy? targetGroup fixedResponseConfig? forwardConfig? order? redirectConfig?

    Properties

    name: string

    The name of the application load balancer listener

    port: number

    Port of the application load balancer listener

    protocol: AlbListenerProtocolEnum

    Protocol of the application load balancer listener. The supported protocols are HTTP and HTTPS

    type: AlbListenerTypeEnum

    Type of the application load balancer listener

    certificate?: string

    Applies to HTTPS listeners. The default certificate for the listener. You must provide exactly one certificate arn or a certificate name which was created by LZA

    sslPolicy?: SslPolicyAlbEnum

    The security policy that defines which protocols and ciphers are supported.

    Application Load Balancer Listener SSL Policies

    targetGroup: string

    Target Group name to which traffic will be forwarded to. This name should be same as ApplicationLoadBalancerTargetGroupConfig | targetGroup name.

    fixedResponseConfig?: IAlbListenerFixedResponseConfig

    Information for creating an action that returns a custom HTTP response. Specify only when type is fixed-response.

    forwardConfig?: IAlbListenerForwardConfig

    Information for creating an action that distributes requests to targetGroup. Stickiness for targetGroup can be set here.

    order?: number

    The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first

    redirectConfig?: IAlbListenerRedirectConfig

    Information for creating a redirect action. Specify only when type is redirect.

    Settings

    Member Visibility

    On This Page

    Properties