AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::RoutingRule

ApiGatewayV2 RoutingRule

Schema for AWS::ApiGatewayV2::RoutingRule

Properties

4 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
Actions
Array<Action>
Required
Conditions
Array<Condition>
Required
DomainNameArn
string
RequiredCreate-only
Priority
integer
Required

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
RoutingRuleArnstringAmazon Resource Name (ARN) of the resource.
RoutingRuleIdstringRoutingRule Id generated by service

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::RoutingRule

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::RoutingRule
    Properties:
      DomainNameArn: "arn:aws:service:region:account:resource"
      Priority: 1
      Conditions: []
      Actions: []

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:CreateRoutingRule

read

apigateway:GetRoutingRule

update

apigateway:UpdateRoutingRule

delete

apigateway:DeleteRoutingRule

list

apigateway:ListRoutingRules

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2
Properties6
Required4
TaggingNot supported
Primary IDRoutingRuleArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainNameArn

Related Resources

External Links