Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApiGatewayManagedOverrides.RouteOverridesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiGatewayManagedOverrides.RouteOverridesProperty.Jsii$Proxy

Enclosing class:

CfnApiGatewayManagedOverrides

@Stability(Stable)
public static interface CfnApiGatewayManagedOverrides.RouteOverridesProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigatewayv2.*;
 RouteOverridesProperty routeOverridesProperty = RouteOverridesProperty.builder()
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .operationName("operationName")
         .target("target")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiGatewayManagedOverrides.RouteOverridesProperty.Builder	A builder for CfnApiGatewayManagedOverrides.RouteOverridesProperty
static final class	CfnApiGatewayManagedOverrides.RouteOverridesProperty.Jsii$Proxy	An implementation for CfnApiGatewayManagedOverrides.RouteOverridesProperty

Method Summary

Modifier and Type	Method	Description
static CfnApiGatewayManagedOverrides.RouteOverridesProperty.Builder	builder()
default List<String>	getAuthorizationScopes()	The authorization scopes supported by this route.
default String	getAuthorizationType()	The authorization type for the route.
default String	getAuthorizerId()	The identifier of the Authorizer resource to be associated with this route.
default String	getOperationName()	The operation name for the route.
default String	getTarget()	For HTTP integrations, specify a fully qualified URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationScopes

@Stability(Stable)
@Nullable
default List<String> getAuthorizationScopes()

The authorization scopes supported by this route.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationscopes

getAuthorizationType

@Stability(Stable)
@Nullable
default String getAuthorizationType()

The authorization type for the route.

To learn more, see AuthorizationType .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizationtype

getAuthorizerId

@Stability(Stable)
@Nullable
default String getAuthorizerId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-authorizerid

getOperationName

@Stability(Stable)
@Nullable
default String getOperationName()

The operation name for the route.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-operationname

getTarget

@Stability(Stable)
@Nullable
default String getTarget()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-apigatewaymanagedoverrides-routeoverrides.html#cfn-apigatewayv2-apigatewaymanagedoverrides-routeoverrides-target

builder

@Stability(Stable)
static CfnApiGatewayManagedOverrides.RouteOverridesProperty.Builder builder()

Returns:

a CfnApiGatewayManagedOverrides.RouteOverridesProperty.Builder of CfnApiGatewayManagedOverrides.RouteOverridesProperty