Package software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2

Class CfnListenerPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.CfnListenerPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T17:00:12.429Z")
@Stability(Stable)
public class CfnListenerPropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a listener for an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnListenerPropsMixin cfnListenerPropsMixin = CfnListenerPropsMixin.Builder.create(CfnListenerMixinProps.builder()
         .alpnPolicy(List.of("alpnPolicy"))
         .certificates(List.of(CertificateProperty.builder()
                 .certificateArn("certificateArn")
                 .build()))
         .defaultActions(List.of(ActionProperty.builder()
                 .authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .onUnauthenticatedRequest("onUnauthenticatedRequest")
                         .scope("scope")
                         .sessionCookieName("sessionCookieName")
                         .sessionTimeout("sessionTimeout")
                         .userPoolArn("userPoolArn")
                         .userPoolClientId("userPoolClientId")
                         .userPoolDomain("userPoolDomain")
                         .build())
                 .authenticateOidcConfig(AuthenticateOidcConfigProperty.builder()
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .authorizationEndpoint("authorizationEndpoint")
                         .clientId("clientId")
                         .clientSecret("clientSecret")
                         .issuer("issuer")
                         .onUnauthenticatedRequest("onUnauthenticatedRequest")
                         .scope("scope")
                         .sessionCookieName("sessionCookieName")
                         .sessionTimeout("sessionTimeout")
                         .tokenEndpoint("tokenEndpoint")
                         .useExistingClientSecret(false)
                         .userInfoEndpoint("userInfoEndpoint")
                         .build())
                 .fixedResponseConfig(FixedResponseConfigProperty.builder()
                         .contentType("contentType")
                         .messageBody("messageBody")
                         .statusCode("statusCode")
                         .build())
                 .forwardConfig(ForwardConfigProperty.builder()
                         .targetGroups(List.of(TargetGroupTupleProperty.builder()
                                 .targetGroupArn("targetGroupArn")
                                 .weight(123)
                                 .build()))
                         .targetGroupStickinessConfig(TargetGroupStickinessConfigProperty.builder()
                                 .durationSeconds(123)
                                 .enabled(false)
                                 .build())
                         .build())
                 .jwtValidationConfig(JwtValidationConfigProperty.builder()
                         .additionalClaims(List.of(JwtValidationActionAdditionalClaimProperty.builder()
                                 .format("format")
                                 .name("name")
                                 .values(List.of("values"))
                                 .build()))
                         .issuer("issuer")
                         .jwksEndpoint("jwksEndpoint")
                         .build())
                 .order(123)
                 .redirectConfig(RedirectConfigProperty.builder()
                         .host("host")
                         .path("path")
                         .port("port")
                         .protocol("protocol")
                         .query("query")
                         .statusCode("statusCode")
                         .build())
                 .targetGroupArn("targetGroupArn")
                 .type("type")
                 .build()))
         .listenerAttributes(List.of(ListenerAttributeProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .loadBalancerArn("loadBalancerArn")
         .mutualAuthentication(MutualAuthenticationProperty.builder()
                 .advertiseTrustStoreCaNames("advertiseTrustStoreCaNames")
                 .ignoreClientCertificateExpiry(false)
                 .mode("mode")
                 .trustStoreArn("trustStoreArn")
                 .build())
         .port(123)
         .protocol("protocol")
         .sslPolicy("sslPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnListenerPropsMixin.ActionProperty	Specifies an action for a listener rule.
static interface	CfnListenerPropsMixin.AuthenticateCognitoConfigProperty	Specifies information required when integrating with Amazon Cognito to authenticate users.
static interface	CfnListenerPropsMixin.AuthenticateOidcConfigProperty	Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
static final class	CfnListenerPropsMixin.Builder	A fluent builder for CfnListenerPropsMixin.
static interface	CfnListenerPropsMixin.CertificateProperty	Specifies an SSL server certificate to use as the default certificate for a secure listener.
static interface	CfnListenerPropsMixin.FixedResponseConfigProperty	Specifies information required when returning a custom HTTP response.
static interface	CfnListenerPropsMixin.ForwardConfigProperty	Information for creating an action that distributes requests among multiple target groups.
static interface	CfnListenerPropsMixin.JwtValidationActionAdditionalClaimProperty	Information about an additional claim to validate.
static interface	CfnListenerPropsMixin.JwtValidationConfigProperty	Example:
static interface	CfnListenerPropsMixin.ListenerAttributeProperty	Information about a listener attribute.
static interface	CfnListenerPropsMixin.MutualAuthenticationProperty	The mutual authentication configuration information.
static interface	CfnListenerPropsMixin.RedirectConfigProperty	Information about a redirect action.
static interface	CfnListenerPropsMixin.TargetGroupStickinessConfigProperty	Information about the target group stickiness for a rule.
static interface	CfnListenerPropsMixin.TargetGroupTupleProperty	Information about how traffic will be distributed between multiple target groups in a forward rule.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnListenerPropsMixin(CfnListenerMixinProps props)	Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::Listener.
	CfnListenerPropsMixin(CfnListenerMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::Listener.
protected	CfnListenerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnListenerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnListenerMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnListenerPropsMixin

protected CfnListenerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnListenerPropsMixin

protected CfnListenerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnListenerPropsMixin

@Stability(Stable)
public CfnListenerPropsMixin(@NotNull
 CfnListenerMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::Listener.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnListenerPropsMixin

@Stability(Stable)
public CfnListenerPropsMixin(@NotNull
 CfnListenerMixinProps props)

Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::Listener.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnListenerMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()