aws-cdk-lib.aws_apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty

interface RouteOverridesProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApiGatewayManagedOverrides_RouteOverridesProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty
Pythonaws_cdk.aws_apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnApiGatewayManagedOverrides » RouteOverridesProperty

The RouteOverrides property overrides the route configuration for an API Gateway-managed route.

If you remove this property, API Gateway restores the default values.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const routeOverridesProperty: apigatewayv2.CfnApiGatewayManagedOverrides.RouteOverridesProperty = {
  authorizationScopes: ['authorizationScopes'],
  authorizationType: 'authorizationType',
  authorizerId: 'authorizerId',
  operationName: 'operationName',
  target: 'target',
};

Properties

NameTypeDescription
authorizationScopes?string[]The authorization scopes supported by this route.
authorizationType?stringThe authorization type for the route.
authorizerId?stringThe identifier of the Authorizer resource to be associated with this route.
operationName?stringThe operation name for the route.
target?stringFor HTTP integrations, specify a fully qualified URL.

authorizationScopes?

Type: string[] (optional)

The authorization scopes supported by this route.


authorizationType?

Type: string (optional)

The authorization type for the route.

To learn more, see AuthorizationType .


authorizerId?

Type: string (optional)

The identifier of the Authorizer resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.


operationName?

Type: string (optional)

The operation name for the route.


target?

Type: string (optional)

For HTTP integrations, specify a fully qualified URL.

For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively.