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

Interface CfnRoutingRuleMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoutingRuleMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.551Z")
@Stability(Stable)
public interface CfnRoutingRuleMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRoutingRulePropsMixin.

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.*;
 CfnRoutingRuleMixinProps cfnRoutingRuleMixinProps = 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();
 

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	CfnRoutingRuleMixinProps.Builder	A builder for CfnRoutingRuleMixinProps
static final class	CfnRoutingRuleMixinProps.Jsii$Proxy	An implementation for CfnRoutingRuleMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnRoutingRuleMixinProps.Builder	builder()
default Object	getActions()	The resulting action based on matching a routing rules condition.
default Object	getConditions()	The conditions of the routing rule.
default String	getDomainNameArn()	The ARN of the domain name.
default 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)
@Nullable
default 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 CfnRoutingRulePropsMixin.ActionProperty>

See Also:

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

getConditions

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

The conditions of the routing rule.

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

See Also:

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

getDomainNameArn

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

Returns:

a CfnRoutingRuleMixinProps.Builder of CfnRoutingRuleMixinProps