Package software.amazon.awscdk.services.apigatewayv2

Class CfnRoutingRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnRoutingRule
All Implemented Interfaces:
IInspectable, IRoutingRuleRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:13.491Z") @Stability(Stable) public class CfnRoutingRule extends CfnResource implements IInspectable, IRoutingRuleRef
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.services.apigatewayv2.*;
 CfnRoutingRule cfnRoutingRule = CfnRoutingRule.Builder.create(this, "MyCfnRoutingRule")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRoutingRule

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

    • CfnRoutingRule

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

    • CfnRoutingRule

      @Stability(Stable) public CfnRoutingRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRoutingRuleProps props)
      Create a new AWS::ApiGatewayV2::RoutingRule.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForRoutingRule

      @Stability(Stable) @NotNull public static String arnForRoutingRule(@NotNull IRoutingRuleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRoutingRule

      @Stability(Stable) @NotNull public static Boolean isCfnRoutingRule(@NotNull Object x)
      Checks whether the given object is a CfnRoutingRule.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRoutingRuleArn

      @Stability(Stable) @NotNull public String getAttrRoutingRuleArn()
      Represents an Amazon Resource Name (ARN).

    • getAttrRoutingRuleId

      @Stability(Stable) @NotNull public String getAttrRoutingRuleId()
      The identifier.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRoutingRuleRef

      @Stability(Stable) @NotNull public RoutingRuleReference getRoutingRuleRef()
      A reference to a RoutingRule resource.
      Specified by:
      getRoutingRuleRef in interface IRoutingRuleRef

    • getActions

      @Stability(Stable) @NotNull public Object getActions()
      The resulting action based on matching a routing rules condition.

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

    • setActions

      @Stability(Stable) public void setActions(@NotNull IResolvable value)
      The resulting action based on matching a routing rules condition.

    • setActions

      @Stability(Stable) public void setActions(@NotNull List<Object> value)
      The resulting action based on matching a routing rules condition.

    • getConditions

      @Stability(Stable) @NotNull public Object getConditions()
      The conditions of the routing rule.

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

    • setConditions

      @Stability(Stable) public void setConditions(@NotNull IResolvable value)
      The conditions of the routing rule.

    • setConditions

      @Stability(Stable) public void setConditions(@NotNull List<Object> value)
      The conditions of the routing rule.

    • getDomainNameArn

      @Stability(Stable) @NotNull public String getDomainNameArn()
      The ARN of the domain name.

    • setDomainNameArn

      @Stability(Stable) public void setDomainNameArn(@NotNull String value)
      The ARN of the domain name.

    • getPriority

      @Stability(Stable) @NotNull public Number getPriority()
      The order in which API Gateway evaluates a rule.

    • setPriority

      @Stability(Stable) public void setPriority(@NotNull Number value)
      The order in which API Gateway evaluates a rule.