AWS::ApiGatewayV2::RoutingRule ActionInvokeApi - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ApiGatewayV2::RoutingRule ActionInvokeApi

Represents an InvokeApi action.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ApiId" : String,
  "Stage" : String,
  "StripBasePath" : Boolean
}

YAML

  ApiId: String
  Stage: String
  StripBasePath: Boolean

Properties

ApiId

The API identifier of the target API.

Required: Yes

Type: String

Update requires: No interruption

Stage

The name of the target stage.

Required: Yes

Type: String

Update requires: No interruption

StripBasePath

The strip base path setting. When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.

Required: No

Type: Boolean

Update requires: No interruption