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

Class CfnListenerRulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.elasticloadbalancingv2.CfnListenerRulePropsMixin

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.440Z")
@Stability(Stable)
public class CfnListenerRulePropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a listener rule.

The listener must be associated with an Application Load Balancer. Each rule consists of a priority, one or more actions, and one or more conditions.

For more information, see Quotas for your Application Load Balancers in the User Guide for Application Load Balancers .

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;
 CfnListenerRulePropsMixin cfnListenerRulePropsMixin = CfnListenerRulePropsMixin.Builder.create(CfnListenerRuleMixinProps.builder()
         .actions(List.of(ActionProperty.builder()
                 .authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .onUnauthenticatedRequest("onUnauthenticatedRequest")
                         .scope("scope")
                         .sessionCookieName("sessionCookieName")
                         .sessionTimeout(123)
                         .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(123)
                         .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()))
         .conditions(List.of(RuleConditionProperty.builder()
                 .field("field")
                 .hostHeaderConfig(HostHeaderConfigProperty.builder()
                         .regexValues(List.of("regexValues"))
                         .values(List.of("values"))
                         .build())
                 .httpHeaderConfig(HttpHeaderConfigProperty.builder()
                         .httpHeaderName("httpHeaderName")
                         .regexValues(List.of("regexValues"))
                         .values(List.of("values"))
                         .build())
                 .httpRequestMethodConfig(HttpRequestMethodConfigProperty.builder()
                         .values(List.of("values"))
                         .build())
                 .pathPatternConfig(PathPatternConfigProperty.builder()
                         .regexValues(List.of("regexValues"))
                         .values(List.of("values"))
                         .build())
                 .queryStringConfig(QueryStringConfigProperty.builder()
                         .values(List.of(QueryStringKeyValueProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .regexValues(List.of("regexValues"))
                 .sourceIpConfig(SourceIpConfigProperty.builder()
                         .ipAddressType("ipAddressType")
                         .values(List.of("values"))
                         .build())
                 .values(List.of("values"))
                 .build()))
         .listenerArn("listenerArn")
         .priority(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transforms(List.of(TransformProperty.builder()
                 .hostHeaderRewriteConfig(RewriteConfigObjectProperty.builder()
                         .rewrites(List.of(RewriteConfigProperty.builder()
                                 .regex("regex")
                                 .replace("replace")
                                 .build()))
                         .build())
                 .type("type")
                 .urlRewriteConfig(RewriteConfigObjectProperty.builder()
                         .rewrites(List.of(RewriteConfigProperty.builder()
                                 .regex("regex")
                                 .replace("replace")
                                 .build()))
                         .build())
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnListenerRulePropsMixin.ActionProperty	Specifies an action for a listener rule.
static interface	CfnListenerRulePropsMixin.AuthenticateCognitoConfigProperty	Specifies information required when integrating with Amazon Cognito to authenticate users.
static interface	CfnListenerRulePropsMixin.AuthenticateOidcConfigProperty	Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.
static final class	CfnListenerRulePropsMixin.Builder	A fluent builder for CfnListenerRulePropsMixin.
static interface	CfnListenerRulePropsMixin.FixedResponseConfigProperty	Specifies information required when returning a custom HTTP response.
static interface	CfnListenerRulePropsMixin.ForwardConfigProperty	Information for creating an action that distributes requests among multiple target groups.
static interface	CfnListenerRulePropsMixin.HostHeaderConfigProperty	Information about a host header condition.
static interface	CfnListenerRulePropsMixin.HttpHeaderConfigProperty	Information about an HTTP header condition.
static interface	CfnListenerRulePropsMixin.HttpRequestMethodConfigProperty	Information about an HTTP method condition.
static interface	CfnListenerRulePropsMixin.JwtValidationActionAdditionalClaimProperty	Information about an additional claim to validate.
static interface	CfnListenerRulePropsMixin.JwtValidationConfigProperty	Example:
static interface	CfnListenerRulePropsMixin.PathPatternConfigProperty	Information about a path pattern condition.
static interface	CfnListenerRulePropsMixin.QueryStringConfigProperty	Information about a query string condition.
static interface	CfnListenerRulePropsMixin.QueryStringKeyValueProperty	Information about a key/value pair.
static interface	CfnListenerRulePropsMixin.RedirectConfigProperty	Information about a redirect action.
static interface	CfnListenerRulePropsMixin.RewriteConfigObjectProperty	Example:
static interface	CfnListenerRulePropsMixin.RewriteConfigProperty	Information about a rewrite transform.
static interface	CfnListenerRulePropsMixin.RuleConditionProperty	Specifies a condition for a listener rule.
static interface	CfnListenerRulePropsMixin.SourceIpConfigProperty	Information about a source IP condition.
static interface	CfnListenerRulePropsMixin.TargetGroupStickinessConfigProperty	Information about the target group stickiness for a rule.
static interface	CfnListenerRulePropsMixin.TargetGroupTupleProperty	Information about how traffic will be distributed between multiple target groups in a forward rule.
static interface	CfnListenerRulePropsMixin.TransformProperty	Example:

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
	CfnListenerRulePropsMixin(CfnListenerRuleMixinProps props)	Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::ListenerRule.
	CfnListenerRulePropsMixin(CfnListenerRuleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ElasticLoadBalancingV2::ListenerRule.
protected	CfnListenerRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnListenerRulePropsMixin(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 CfnListenerRuleMixinProps	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

CfnListenerRulePropsMixin

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

CfnListenerRulePropsMixin

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

CfnListenerRulePropsMixin

@Stability(Stable)
public CfnListenerRulePropsMixin(@NotNull
 CfnListenerRuleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnListenerRulePropsMixin

@Stability(Stable)
public CfnListenerRulePropsMixin(@NotNull
 CfnListenerRuleMixinProps props)

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

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 CfnListenerRuleMixinProps getProps()

getStrategy

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