HttpRoute

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

Bases: Resource

Route class that creates the Route for API Gateway HTTP API.

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.
from aws_cdk import 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) – the API the route is associated with.
route_key (HttpRouteKey) – The key to this route. This is a combination of an HTTP method and an HTTP path.
authorization_scopes (Optional[Sequence[str]]) – 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]) – Authorizer for a WebSocket API or an HTTP API. Default: - No authorizer
integration (HttpRouteIntegration) – The integration to be configured on this route.

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)

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]]) – The HTTP methods to allow. Default: - the HttpMethod of the route

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: The HTTP API associated with this route.

node: The tree node.

path: Returns the path component of this HTTP route, undefined if the path is the catch-all route.

route_arn: Returns the arn of the route.

route_id: Id of the Route.

stack: The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool