Class ApplicationLoadBalancerListenerConfig

CustomizationsConfig / AppConfigItem / ApplicationLoadBalancerConfig / ApplicationLoadBalancerListenerConfig

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

See

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

Example

 - 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

Hierarchy

  • ApplicationLoadBalancerListenerConfig

Implements

Constructors

constructor

Properties

certificate fixedResponseConfig forwardConfig name order port protocol redirectConfig sslPolicy targetGroup type

Constructors

constructor

Properties

Readonly certificate

certificate: undefined | string = undefined

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

Readonly fixedResponseConfig

fixedResponseConfig: undefined | AlbListenerFixedResponseConfig = undefined

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

Readonly forwardConfig

forwardConfig: undefined | AlbListenerForwardConfig = undefined

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

Readonly name

name: string = ''

The name of the application load balancer listener

Readonly order

order: undefined | number = undefined

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

Readonly port

port: number = 80

Port of the application load balancer listener

Readonly protocol

protocol: "HTTP" | "HTTPS" = 'HTTP'

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

Readonly redirectConfig

redirectConfig: undefined | AlbListenerRedirectConfig = undefined

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

Readonly sslPolicy

sslPolicy: undefined | "ELBSecurityPolicy-TLS-1-0-2015-04" | "ELBSecurityPolicy-TLS-1-1-2017-01" | "ELBSecurityPolicy-TLS-1-2-2017-01" | "ELBSecurityPolicy-TLS-1-2-Ext-2018-06" | "ELBSecurityPolicy-FS-2018-06" | "ELBSecurityPolicy-FS-1-1-2019-08" | "ELBSecurityPolicy-FS-1-2-2019-08" | "ELBSecurityPolicy-FS-1-2-Res-2019-08" | "ELBSecurityPolicy-2015-05" | "ELBSecurityPolicy-FS-1-2-Res-2020-10" | "ELBSecurityPolicy-2016-08" = undefined

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

See

Application Load Balancer Listener SSL Policies

Readonly targetGroup

targetGroup: string = ''

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

Readonly type

type: "forward" | "redirect" | "fixed-response" = 'forward'

Type of the application load balancer listener

Settings

Member Visibility

Theme

Generated using TypeDoc