Package software.amazon.awscdk.services.apigatewayv2

Interface CfnRoutingRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoutingRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.839Z")
@Stability(Stable)
public interface CfnRoutingRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRoutingRule.

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.apigatewayv2.*;
 CfnRoutingRuleProps cfnRoutingRuleProps = CfnRoutingRuleProps.builder()
         .actions(List.of(ActionProperty.builder()
                 .invokeApi(ActionInvokeApiProperty.builder()
                         .apiId("apiId")
                         .stage("stage")
                         // the properties below are optional
                         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRoutingRuleProps.Builder	builder()
Object	getActions()	The resulting action based on matching a routing rules condition.
Object	getConditions()	The conditions of the routing rule.
String	getDomainNameArn()	The ARN of the domain name.
Number	getPriority()	The order in which API Gateway evaluates a rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRoutingRule.ActionProperty>

See Also:

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

getConditions

@Stability(Stable)
@NotNull
Object getConditions()

The conditions of the routing rule.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRoutingRule.ConditionProperty>

See Also:

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

getDomainNameArn

@Stability(Stable)
@NotNull
String getDomainNameArn()

The ARN of the domain name.

See Also:

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

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

The order in which API Gateway evaluates a rule.

Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.

See Also:

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

builder

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

Returns:

a CfnRoutingRuleProps.Builder of CfnRoutingRuleProps