software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerProps

All Known Implementing Classes:

CfnListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.579Z")
public interface CfnListenerProps

Properties for defining a `CfnListener`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 CfnListenerProps cfnListenerProps = CfnListenerProps.builder()
         .defaultActions(List.of(ActionProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
                         .userPoolArn("userPoolArn")
                         .userPoolClientId("userPoolClientId")
                         .userPoolDomain("userPoolDomain")
                         // the properties below are optional
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .onUnauthenticatedRequest("onUnauthenticatedRequest")
                         .scope("scope")
                         .sessionCookieName("sessionCookieName")
                         .sessionTimeout("sessionTimeout")
                         .build())
                 .authenticateOidcConfig(AuthenticateOidcConfigProperty.builder()
                         .authorizationEndpoint("authorizationEndpoint")
                         .clientId("clientId")
                         .issuer("issuer")
                         .tokenEndpoint("tokenEndpoint")
                         .userInfoEndpoint("userInfoEndpoint")
                         // the properties below are optional
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .clientSecret("clientSecret")
                         .onUnauthenticatedRequest("onUnauthenticatedRequest")
                         .scope("scope")
                         .sessionCookieName("sessionCookieName")
                         .sessionTimeout("sessionTimeout")
                         .useExistingClientSecret(false)
                         .build())
                 .fixedResponseConfig(FixedResponseConfigProperty.builder()
                         .statusCode("statusCode")
                         // the properties below are optional
                         .contentType("contentType")
                         .messageBody("messageBody")
                         .build())
                 .forwardConfig(ForwardConfigProperty.builder()
                         .targetGroups(List.of(TargetGroupTupleProperty.builder()
                                 .targetGroupArn("targetGroupArn")
                                 .weight(123)
                                 .build()))
                         .targetGroupStickinessConfig(TargetGroupStickinessConfigProperty.builder()
                                 .durationSeconds(123)
                                 .enabled(false)
                                 .build())
                         .build())
                 .order(123)
                 .redirectConfig(RedirectConfigProperty.builder()
                         .statusCode("statusCode")
                         // the properties below are optional
                         .host("host")
                         .path("path")
                         .port("port")
                         .protocol("protocol")
                         .query("query")
                         .build())
                 .targetGroupArn("targetGroupArn")
                 .build()))
         .loadBalancerArn("loadBalancerArn")
         // the properties below are optional
         .alpnPolicy(List.of("alpnPolicy"))
         .certificates(List.of(CertificateProperty.builder()
                 .certificateArn("certificateArn")
                 .build()))
         .port(123)
         .protocol("protocol")
         .sslPolicy("sslPolicy")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnListenerProps.Builder A builder for CfnListenerProps
static class	CfnListenerProps.Jsii$Proxy An implementation for CfnListenerProps

Method Summary

Modifier and Type	Method and Description
static CfnListenerProps.Builder	builder()
default java.util.List<java.lang.String>	getAlpnPolicy() [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
default java.lang.Object	getCertificates() The default SSL server certificate for a secure listener.
java.lang.Object	getDefaultActions() The actions for the default rule.
java.lang.String	getLoadBalancerArn() The Amazon Resource Name (ARN) of the load balancer.
default java.lang.Number	getPort() The port on which the load balancer is listening.
default java.lang.String	getProtocol() The protocol for connections from clients to the load balancer.
default java.lang.String	getSslPolicy() [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

Method Detail

getDefaultActions

java.lang.Object getDefaultActions()

The actions for the default rule. You cannot define a condition for a default rule.

To create additional rules for an Application Load Balancer, use AWS::ElasticLoadBalancingV2::ListenerRule .

getLoadBalancerArn

java.lang.String getLoadBalancerArn()

The Amazon Resource Name (ARN) of the load balancer.

getAlpnPolicy

default java.util.List<java.lang.String> getAlpnPolicy()

[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.

getCertificates

default java.lang.Object getCertificates()

The default SSL server certificate for a secure listener.

You must provide exactly one certificate if the listener protocol is HTTPS or TLS.

To create a certificate list for a secure listener, use AWS::ElasticLoadBalancingV2::ListenerCertificate .

getPort

default java.lang.Number getPort()

The port on which the load balancer is listening.

You cannot specify a port for a Gateway Load Balancer.

getProtocol

default java.lang.String getProtocol()

The protocol for connections from clients to the load balancer.

For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.

getSslPolicy

default java.lang.String getSslPolicy()

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported.

For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide .

builder

static CfnListenerProps.Builder builder()

Returns:

a CfnListenerProps.Builder of CfnListenerProps