HttpRoute

class aws_cdk.aws_apigatewayv2.HttpRoute(scope, id, *, http_api, route_key, authorization_scopes=None, authorizer=None, integration)

Bases: Resource

(experimental) Route class that creates the Route for API Gateway HTTP API.

Stability:

experimental

Resource:

AWS::ApiGatewayV2::Route

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# http_api: apigatewayv2.HttpApi
# http_route_authorizer: apigatewayv2.IHttpRouteAuthorizer
# http_route_integration: apigatewayv2.HttpRouteIntegration
# http_route_key: apigatewayv2.HttpRouteKey

http_route = apigatewayv2.HttpRoute(self, "MyHttpRoute",
    http_api=http_api,
    integration=http_route_integration,
    route_key=http_route_key,

    # the properties below are optional
    authorization_scopes=["authorizationScopes"],
    authorizer=http_route_authorizer
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • http_api (IHttpApi) – (experimental) the API the route is associated with.

  • route_key (HttpRouteKey) – (experimental) The key to this route. This is a combination of an HTTP method and an HTTP path.

  • authorization_scopes (Optional[Sequence[str]]) – (experimental) The list of OIDC scopes to include in the authorization. These scopes will be merged with the scopes from the attached authorizer Default: - no additional authorization scopes

  • authorizer (Optional[IHttpRouteAuthorizer]) – (experimental) Authorizer for a WebSocket API or an HTTP API. Default: - No authorizer

  • integration (HttpRouteIntegration) – (experimental) The integration to be configured on this route.

Stability:

experimental

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant_invoke(grantee, *, http_methods=None)

(experimental) Grant access to invoke the route.

This method requires that the authorizer of the route is undefined or is an HttpIamAuthorizer.

Parameters:

  • grantee (IGrantable) –

  • http_methods (Optional[Sequence[HttpMethod]]) – (experimental) The HTTP methods to allow. Default: - the HttpMethod of the route

Stability:

experimental

Return type:

Grant

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

http_api

(experimental) The HTTP API associated with this route.

Stability:

experimental

node

The construct tree node associated with this construct.

path

(experimental) Returns the path component of this HTTP route, undefined if the path is the catch-all route.

Stability:

experimental

route_arn

(experimental) Returns the arn of the route.

Stability:

experimental

route_id

(experimental) Id of the Route.

Stability:

experimental

stack

The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool