Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Class CfnRoutingRulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnRoutingRulePropsMixin

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.552Z")
@Stability(Stable)
public class CfnRoutingRulePropsMixin
extends Mixin
implements software.constructs.IMixin

Represents a routing rule.

When the incoming request to a domain name matches the conditions for a rule, API Gateway invokes a stage of a target API. Supported only for REST APIs.

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.apigatewayv2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnRoutingRulePropsMixin cfnRoutingRulePropsMixin = CfnRoutingRulePropsMixin.Builder.create(CfnRoutingRuleMixinProps.builder()
         .actions(List.of(ActionProperty.builder()
                 .invokeApi(ActionInvokeApiProperty.builder()
                         .apiId("apiId")
                         .stage("stage")
                         .stripBasePath(false)
                         .build())
                 .build()))
         .conditions(List.of(ConditionProperty.builder()
                 .matchBasePaths(MatchBasePathsProperty.builder()
                         .anyOf(List.of("anyOf"))
                         .build())
                 .matchHeaders(MatchHeadersProperty.builder()
                         .anyOf(List.of(MatchHeaderValueProperty.builder()
                                 .header("header")
                                 .valueGlob("valueGlob")
                                 .build()))
                         .build())
                 .build()))
         .domainNameArn("domainNameArn")
         .priority(123)
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routingrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRoutingRulePropsMixin.ActionInvokeApiProperty	Represents an InvokeApi action.
static interface	CfnRoutingRulePropsMixin.ActionProperty	Represents a routing rule action.
static final class	CfnRoutingRulePropsMixin.Builder	A fluent builder for CfnRoutingRulePropsMixin.
static interface	CfnRoutingRulePropsMixin.ConditionProperty	Represents a condition.
static interface	CfnRoutingRulePropsMixin.MatchBasePathsProperty	Represents a MatchBasePaths condition.
static interface	CfnRoutingRulePropsMixin.MatchHeadersProperty	Represents a MatchHeaders condition.
static interface	CfnRoutingRulePropsMixin.MatchHeaderValueProperty	Represents a MatchHeaderValue .

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
	CfnRoutingRulePropsMixin(CfnRoutingRuleMixinProps props)	Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.
	CfnRoutingRulePropsMixin(CfnRoutingRuleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.
protected	CfnRoutingRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRoutingRulePropsMixin(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 CfnRoutingRuleMixinProps	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

CfnRoutingRulePropsMixin

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

CfnRoutingRulePropsMixin

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

CfnRoutingRulePropsMixin

@Stability(Stable)
public CfnRoutingRulePropsMixin(@NotNull
 CfnRoutingRuleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.

Parameters:

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

options - Mixin options.

CfnRoutingRulePropsMixin

@Stability(Stable)
public CfnRoutingRulePropsMixin(@NotNull
 CfnRoutingRuleMixinProps props)

Create a mixin to apply properties to AWS::ApiGatewayV2::RoutingRule.

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

getStrategy

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