AWS::ApiGatewayV2::ApiGatewayManagedOverrides - Amazon CloudFormation
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.


The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create. When you create an API by using quick create, an AWS::ApiGatewayV2::Route, AWS::ApiGatewayV2::Integration, and AWS::ApiGatewayV2::Stage are created for you and associated with your AWS::ApiGatewayV2::Api. The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource enables you to set, or override the properties of these implicit resources. Supported only for HTTP APIs.


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


{ "Type" : "AWS::ApiGatewayV2::ApiGatewayManagedOverrides", "Properties" : { "ApiId" : String, "Integration" : IntegrationOverrides, "Route" : RouteOverrides, "Stage" : StageOverrides } }


Type: AWS::ApiGatewayV2::ApiGatewayManagedOverrides Properties: ApiId: String Integration: IntegrationOverrides Route: RouteOverrides Stage: StageOverrides



The ID of the API for which to override the configuration of API Gateway-managed resources.

Required: Yes

Type: String

Update requires: Replacement


Overrides the integration configuration for an API Gateway-managed integration.

Required: No

Type: IntegrationOverrides

Update requires: No interruption


Overrides the route configuration for an API Gateway-managed route.

Required: No

Type: RouteOverrides

Update requires: No interruption


Overrides the stage configuration for an API Gateway-managed stage.

Required: No

Type: StageOverrides

Update requires: No interruption