ListenerArgs class

The set of arguments for Listener. The set of arguments for Listener.

Constructors

ListenerArgs({Input<String?>? alpnPolicy, Input<String?>? certificateArn, required Input<List<ListenerDefaultAction>> defaultActions, required Input<String> loadBalancerArn, Input<ListenerMutualAuthentication?>? mutualAuthentication, Input<int?>? port, Input<String?>? protocol, Input<String?>? region, Input<String?>? routingHttpRequestXAmznMtlsClientcertHeaderName, Input<String?>? routingHttpRequestXAmznMtlsClientcertIssuerHeaderName, Input<String?>? routingHttpRequestXAmznMtlsClientcertLeafHeaderName, Input<String?>? routingHttpRequestXAmznMtlsClientcertSerialNumberHeaderName, Input<String?>? routingHttpRequestXAmznMtlsClientcertSubjectHeaderName, Input<String?>? routingHttpRequestXAmznMtlsClientcertValidityHeaderName, Input<String?>? routingHttpRequestXAmznTlsCipherSuiteHeaderName, Input<String?>? routingHttpRequestXAmznTlsVersionHeaderName, Input<String?>? routingHttpResponseAccessControlAllowCredentialsHeaderValue, Input<String?>? routingHttpResponseAccessControlAllowHeadersHeaderValue, Input<String?>? routingHttpResponseAccessControlAllowMethodsHeaderValue, Input<String?>? routingHttpResponseAccessControlAllowOriginHeaderValue, Input<String?>? routingHttpResponseAccessControlExposeHeadersHeaderValue, Input<String?>? routingHttpResponseAccessControlMaxAgeHeaderValue, Input<String?>? routingHttpResponseContentSecurityPolicyHeaderValue, Input<bool?>? routingHttpResponseServerEnabled, Input<String?>? routingHttpResponseStrictTransportSecurityHeaderValue, Input<String?>? routingHttpResponseXContentTypeOptionsHeaderValue, Input<String?>? routingHttpResponseXFrameOptionsHeaderValue, Input<String?>? sslPolicy, Input<Map<String, String>?>? tags, Input<int?>? tcpIdleTimeoutSeconds})
Creates a new ListenerArgs. alpnPolicy Name of the Application-Layer Protocol Negotiation (ALPN) policy. Can be set if protocol is TLS. Valid values are HTTP1Only, HTTP2Only, HTTP2Optional, HTTP2Preferred, and None. certificateArn ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the aws.lb.ListenerCertificate resource. defaultActions Configuration block for default actions. See below. loadBalancerArn ARN of the load balancer. mutualAuthentication The mutual authentication configuration information. See below. port Port on which the load balancer is listening. Not valid for Gateway Load Balancers. protocol Protocol for connections from clients to the load balancer. For Application Load Balancers, valid values are HTTP and HTTPS, with a default of HTTP. For Network Load Balancers, valid values are TCP, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC. Not valid to use UDP or TCP_UDP if dual-stack mode is enabled. Not valid to use QUIC or TCP_QUIC if security groups are configured or dual-stack mode is enabled. Not valid for Gateway Load Balancers. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. routingHttpRequestXAmznMtlsClientcertHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznMtlsClientcertIssuerHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Issuer HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznMtlsClientcertLeafHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Leaf HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznMtlsClientcertSerialNumberHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Serial-Number HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznMtlsClientcertSubjectHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Subject HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznMtlsClientcertValidityHeaderName Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Validity HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznTlsCipherSuiteHeaderName Enables you to modify the header name of the X-Amzn-Tls-Cipher-Suite HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpRequestXAmznTlsVersionHeaderName Enables you to modify the header name of the X-Amzn-Tls-Version HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers. routingHttpResponseAccessControlAllowCredentialsHeaderValue Specifies which headers the browser can expose to the requesting client. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value is true. routingHttpResponseAccessControlAllowHeadersHeaderValue Specifies which headers can be used during the request. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are *, Accept, Accept-Language, Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, Pragma. Dependent on your use-case other headers can be exposed and then set as a value consult the Access-Control-Allow-Headers documentation. routingHttpResponseAccessControlAllowMethodsHeaderValue Set which HTTP methods are allowed when accessing the server from a different origin. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are GET, HEAD, POST, DELETE, CONNECT, OPTIONS, TRACE or PATCH. routingHttpResponseAccessControlAllowOriginHeaderValue Specifies which origins are allowed to access the server. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. A valid value is a URI, eg: https://example.com. routingHttpResponseAccessControlExposeHeadersHeaderValue Specifies whether the browser should include credentials such as cookies or authentication when making requests. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are *, Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, or Pragma. Dependent on your use-case other headers can be exposed, consult the Access-Control-Expose-Headers documentation. routingHttpResponseAccessControlMaxAgeHeaderValue Specifies how long the results of a preflight request can be cached, in seconds. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are between 0 and 86400. This value is browser specific, consult the Access-Control-Max-Age documentation. routingHttpResponseContentSecurityPolicyHeaderValue Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Values for this are extensive, and can be impactful when set, consult Content-Security-Policy documentation. routingHttpResponseServerEnabled Enables you to allow or remove the HTTP response server header. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are true or false. routingHttpResponseStrictTransportSecurityHeaderValue Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. Default values are max-age=31536000; includeSubDomains; preload consult the Strict-Transport-Security documentation for further details. routingHttpResponseXContentTypeOptionsHeaderValue Indicates whether the MIME types advertised in the Content-Type headers should be followed and not be changed. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value is nosniff. routingHttpResponseXFrameOptionsHeaderValue Indicates whether the browser is allowed to render a page in a frame, iframe, embed or object. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid values are DENY, SAMEORIGIN, or ALLOW-FROM https://example.com. sslPolicy Name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS. Default is ELBSecurityPolicy-2016-08. tags A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tcpIdleTimeoutSeconds TCP idle timeout value in seconds. Can only be set if protocol is TCP on Network Load Balancer, or with a Gateway Load Balancer. Not supported for Application Load Balancers. Valid values are between 60 and 6000 inclusive. Default: 350.
const
ListenerArgs.fromMap(Map<String, dynamic> map)
factory

Properties

alpnPolicy → Input<String?>?
Name of the Application-Layer Protocol Negotiation (ALPN) policy. Can be set if protocol is TLS. Valid values are HTTP1Only, HTTP2Only, HTTP2Optional, HTTP2Preferred, and None.
final
certificateArn → Input<String?>?
ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the aws.lb.ListenerCertificate resource.
final
defaultActions → Input<List<ListenerDefaultAction>>
Configuration block for default actions. See below.
final
hashCode → int
The hash code for this object.
no setterinherited
loadBalancerArn → Input<String>
ARN of the load balancer.
final
mutualAuthentication → Input<ListenerMutualAuthentication?>?
The mutual authentication configuration information. See below.
final
port → Input<int?>?
Port on which the load balancer is listening. Not valid for Gateway Load Balancers.
final
protocol → Input<String?>?
Protocol for connections from clients to the load balancer. For Application Load Balancers, valid values are HTTP and HTTPS, with a default of HTTP. For Network Load Balancers, valid values are TCP, TLS, UDP, TCP_UDP, QUIC, and TCP_QUIC. Not valid to use UDP or TCP_UDP if dual-stack mode is enabled. Not valid to use QUIC or TCP_QUIC if security groups are configured or dual-stack mode is enabled. Not valid for Gateway Load Balancers.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
routingHttpRequestXAmznMtlsClientcertHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznMtlsClientcertIssuerHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Issuer HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznMtlsClientcertLeafHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Leaf HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznMtlsClientcertSerialNumberHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Serial-Number HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznMtlsClientcertSubjectHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Subject HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznMtlsClientcertValidityHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Validity HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznTlsCipherSuiteHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Tls-Cipher-Suite HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpRequestXAmznTlsVersionHeaderName → Input<String?>?
Enables you to modify the header name of the X-Amzn-Tls-Version HTTP request header. Can only be set if protocol is HTTPS for Application Load Balancers.
final
routingHttpResponseAccessControlAllowCredentialsHeaderValue → Input<String?>?
Specifies which headers the browser can expose to the requesting client. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value is true.
final
routingHttpResponseAccessControlAllowHeadersHeaderValue → Input<String?>?
Specifies which headers can be used during the request. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are *, Accept, Accept-Language, Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, Pragma. Dependent on your use-case other headers can be exposed and then set as a value consult the Access-Control-Allow-Headers documentation.
final
routingHttpResponseAccessControlAllowMethodsHeaderValue → Input<String?>?
Set which HTTP methods are allowed when accessing the server from a different origin. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are GET, HEAD, POST, DELETE, CONNECT, OPTIONS, TRACE or PATCH.
final
routingHttpResponseAccessControlAllowOriginHeaderValue → Input<String?>?
Specifies which origins are allowed to access the server. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. A valid value is a URI, eg: https://example.com.
final
routingHttpResponseAccessControlExposeHeadersHeaderValue → Input<String?>?
Specifies whether the browser should include credentials such as cookies or authentication when making requests. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are *, Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified, or Pragma. Dependent on your use-case other headers can be exposed, consult the Access-Control-Expose-Headers documentation.
final
routingHttpResponseAccessControlMaxAgeHeaderValue → Input<String?>?
Specifies how long the results of a preflight request can be cached, in seconds. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are between 0 and 86400. This value is browser specific, consult the Access-Control-Max-Age documentation.
final
routingHttpResponseContentSecurityPolicyHeaderValue → Input<String?>?
Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Values for this are extensive, and can be impactful when set, consult Content-Security-Policy documentation.
final
routingHttpResponseServerEnabled → Input<bool?>?
Enables you to allow or remove the HTTP response server header. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are true or false.
final
routingHttpResponseStrictTransportSecurityHeaderValue → Input<String?>?
Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. Default values are max-age=31536000; includeSubDomains; preload consult the Strict-Transport-Security documentation for further details.
final
routingHttpResponseXContentTypeOptionsHeaderValue → Input<String?>?
Indicates whether the MIME types advertised in the Content-Type headers should be followed and not be changed. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value is nosniff.
final
routingHttpResponseXFrameOptionsHeaderValue → Input<String?>?
Indicates whether the browser is allowed to render a page in a frame, iframe, embed or object. Can only be set if protocol is HTTP or HTTPS for Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid values are DENY, SAMEORIGIN, or ALLOW-FROM https://example.com.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sslPolicy → Input<String?>?
Name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS. Default is ELBSecurityPolicy-2016-08.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tcpIdleTimeoutSeconds → Input<int?>?
TCP idle timeout value in seconds. Can only be set if protocol is TCP on Network Load Balancer, or with a Gateway Load Balancer. Not supported for Application Load Balancers. Valid values are between 60 and 6000 inclusive. Default: 350.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited