Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:29.821Z")
@Stability(Stable)
public interface CfnListenerProps
extends software.amazon.jsii.JsiiSerializable

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()))
         .mutualAuthentication(MutualAuthenticationProperty.builder()
                 .ignoreClientCertificateExpiry(false)
                 .mode("mode")
                 .trustStoreArn("trustStoreArn")
                 .build())
         .port(123)
         .protocol("protocol")
         .sslPolicy("sslPolicy")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultActions

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-defaultactions

getLoadBalancerArn

@Stability(Stable)
@NotNull
String getLoadBalancerArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-loadbalancerarn

getAlpnPolicy

@Stability(Stable)
@Nullable
default List<String> getAlpnPolicy()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-alpnpolicy

getCertificates

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-certificates

getMutualAuthentication

@Stability(Stable)
@Nullable
default Object getMutualAuthentication()

The mutual authentication configuration information.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-mutualauthentication

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port on which the load balancer is listening.

You cannot specify a port for a Gateway Load Balancer.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-port

getProtocol

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-protocol

getSslPolicy

@Stability(Stable)
@Nullable
default String getSslPolicy()

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

Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listener.html#cfn-elasticloadbalancingv2-listener-sslpolicy

builder

@Stability(Stable)
static CfnListenerProps.Builder builder()

Returns:

a CfnListenerProps.Builder of CfnListenerProps