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< defaultActions, required Input<ListenerDefaultAction> >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< ? tags, Input<String, String> ?>int?> ? tcpIdleTimeoutSeconds}) -
Creates a new ListenerArgs.
alpnPolicyName of the Application-Layer Protocol Negotiation (ALPN) policy. Can be set ifprotocolisTLS. Valid values areHTTP1Only,HTTP2Only,HTTP2Optional,HTTP2Preferred, andNone.certificateArnARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see theaws.lb.ListenerCertificateresource.defaultActionsConfiguration block for default actions. See below.loadBalancerArnARN of the load balancer.mutualAuthenticationThe mutual authentication configuration information. See below.portPort on which the load balancer is listening. Not valid for Gateway Load Balancers.protocolProtocol for connections from clients to the load balancer. For Application Load Balancers, valid values areHTTPandHTTPS, with a default ofHTTP. For Network Load Balancers, valid values areTCP,TLS,UDP,TCP_UDP,QUIC, andTCP_QUIC. Not valid to useUDPorTCP_UDPif dual-stack mode is enabled. Not valid to useQUICorTCP_QUICif security groups are configured or dual-stack mode is enabled. Not valid for Gateway Load Balancers.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.routingHttpRequestXAmznMtlsClientcertHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-ClientcertHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznMtlsClientcertIssuerHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-Clientcert-IssuerHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznMtlsClientcertLeafHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-Clientcert-LeafHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznMtlsClientcertSerialNumberHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-Clientcert-Serial-NumberHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznMtlsClientcertSubjectHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-Clientcert-SubjectHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznMtlsClientcertValidityHeaderNameEnables you to modify the header name of theX-Amzn-Mtls-Clientcert-ValidityHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznTlsCipherSuiteHeaderNameEnables you to modify the header name of theX-Amzn-Tls-Cipher-SuiteHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpRequestXAmznTlsVersionHeaderNameEnables you to modify the header name of theX-Amzn-Tls-VersionHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.routingHttpResponseAccessControlAllowCredentialsHeaderValueSpecifies which headers the browser can expose to the requesting client. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value istrue.routingHttpResponseAccessControlAllowHeadersHeaderValueSpecifies which headers can be used during the request. Can only be set if protocol isHTTPorHTTPSfor 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.routingHttpResponseAccessControlAllowMethodsHeaderValueSet which HTTP methods are allowed when accessing the server from a different origin. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values areGET,HEAD,POST,DELETE,CONNECT,OPTIONS,TRACEorPATCH.routingHttpResponseAccessControlAllowOriginHeaderValueSpecifies which origins are allowed to access the server. Can only be set if protocol isHTTPorHTTPSfor 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.routingHttpResponseAccessControlExposeHeadersHeaderValueSpecifies whether the browser should include credentials such as cookies or authentication when making requests. Can only be set if protocol isHTTPorHTTPSfor 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, orPragma. Dependent on your use-case other headers can be exposed, consult the Access-Control-Expose-Headers documentation.routingHttpResponseAccessControlMaxAgeHeaderValueSpecifies how long the results of a preflight request can be cached, in seconds. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are between0and86400. This value is browser specific, consult the Access-Control-Max-Age documentation.routingHttpResponseContentSecurityPolicyHeaderValueSpecifies restrictions enforced by the browser to help minimize the risk of certain types of security threats. Can only be set if protocol isHTTPorHTTPSfor 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.routingHttpResponseServerEnabledEnables you to allow or remove the HTTP response server header. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values aretrueorfalse.routingHttpResponseStrictTransportSecurityHeaderValueInforms 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 aremax-age=31536000; includeSubDomains; preloadconsult the Strict-Transport-Security documentation for further details.routingHttpResponseXContentTypeOptionsHeaderValueIndicates whether the MIME types advertised in the Content-Type headers should be followed and not be changed. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value isnosniff.routingHttpResponseXFrameOptionsHeaderValueIndicates whether the browser is allowed to render a page in a frame, iframe, embed or object. Can only be set if protocol isHTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid values areDENY,SAMEORIGIN, orALLOW-FROM https://example.com.sslPolicyName of the SSL Policy for the listener. Required ifprotocolisHTTPSorTLS. Default isELBSecurityPolicy-2016-08.tagsA map of tags to assign to the resource. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tcpIdleTimeoutSecondsTCP idle timeout value in seconds. Can only be set if protocol isTCPon Network Load Balancer, or with a Gateway Load Balancer. Not supported for Application Load Balancers. Valid values are between60and6000inclusive. 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
protocolisTLS. Valid values areHTTP1Only,HTTP2Only,HTTP2Optional,HTTP2Preferred, andNone.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.ListenerCertificateresource.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
HTTPandHTTPS, with a default ofHTTP. For Network Load Balancers, valid values areTCP,TLS,UDP,TCP_UDP,QUIC, andTCP_QUIC. Not valid to useUDPorTCP_UDPif dual-stack mode is enabled. Not valid to useQUICorTCP_QUICif 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-ClientcertHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznMtlsClientcertIssuerHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Mtls-Clientcert-IssuerHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznMtlsClientcertLeafHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Mtls-Clientcert-LeafHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznMtlsClientcertSerialNumberHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Mtls-Clientcert-Serial-NumberHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznMtlsClientcertSubjectHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Mtls-Clientcert-SubjectHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznMtlsClientcertValidityHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Mtls-Clientcert-ValidityHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznTlsCipherSuiteHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Tls-Cipher-SuiteHTTP request header. Can only be set if protocol isHTTPSfor Application Load Balancers.final -
routingHttpRequestXAmznTlsVersionHeaderName
→ Input<
String?> ? -
Enables you to modify the header name of the
X-Amzn-Tls-VersionHTTP request header. Can only be set if protocol isHTTPSfor 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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value istrue.final -
routingHttpResponseAccessControlAllowHeadersHeaderValue
→ Input<
String?> ? -
Specifies which headers can be used during the request. Can only be set if protocol is
HTTPorHTTPSfor 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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values areGET,HEAD,POST,DELETE,CONNECT,OPTIONS,TRACEorPATCH.final -
routingHttpResponseAccessControlAllowOriginHeaderValue
→ Input<
String?> ? -
Specifies which origins are allowed to access the server. Can only be set if protocol is
HTTPorHTTPSfor 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
HTTPorHTTPSfor 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, orPragma. 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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values are between0and86400. 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
HTTPorHTTPSfor 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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. Valid values aretrueorfalse.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; preloadconsult 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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid value isnosniff.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
HTTPorHTTPSfor Application Load Balancers. Not supported for Network Load Balancer, or with a Gateway Load Balancer. The only valid values areDENY,SAMEORIGIN, orALLOW-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
protocolisHTTPSorTLS. Default isELBSecurityPolicy-2016-08.final -
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration 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
TCPon Network Load Balancer, or with a Gateway Load Balancer. Not supported for Application Load Balancers. Valid values are between60and6000inclusive. 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