AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGatewayV2::ApiGatewayManagedOverrides

CfnApiGatewayManagedOverrides

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.

Import

import { CfnApiGatewayManagedOverrides } from 'aws-cdk-lib/aws-apigatewayv2';

Or use the module namespace:

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.CfnApiGatewayManagedOverrides

Properties

Configuration passed to the constructor as CfnApiGatewayManagedOverridesProps.

apiIdRequired
string

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

integrationOptional
IResolvable | IntegrationOverridesProperty

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

routeOptional
IResolvable | RouteOverridesProperty

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

stageOptional
IResolvable | StageOverridesProperty

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

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

Subscribe to Newsletter