AWS::ApiGatewayV2::ApiGatewayManagedOverrides RouteOverrides - 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).

AWS::ApiGatewayV2::ApiGatewayManagedOverrides RouteOverrides

The RouteOverrides property overrides the route configuration for an API Gateway-managed route. If you remove this property, API Gateway restores the default values.

Syntax

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

JSON

{
  "AuthorizationScopes" : [ String, ... ],
  "AuthorizationType" : String,
  "AuthorizerId" : String,
  "OperationName" : String,
  "Target" : String
}

YAML

  AuthorizationScopes: 
    - String
  AuthorizationType: String
  AuthorizerId: String
  OperationName: String
  Target: String

Properties

AuthorizationScopes

The authorization scopes supported by this route.

Required: No

Type: List of String

Update requires: No interruption

AuthorizationType

The authorization type for the route. To learn more, see AuthorizationType.

Required: No

Type: String

Update requires: No interruption

AuthorizerId

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.

Required: No

Type: String

Update requires: No interruption

OperationName

The operation name for the route.

Required: No

Type: String

Update requires: No interruption

Target

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.

Required: No

Type: String

Update requires: No interruption