HttpRoute

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

Bases: aws_cdk.core.Resource

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

Stability

experimental

Resource

AWS::ApiGatewayV2::Route

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 (IHttpRouteIntegration) – (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.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

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.

Return type

ResourceEnvironment

http_api

(experimental) The HTTP API associated with this route.

Stability

experimental

Return type

IHttpApi

node

The construct tree node associated with this construct.

Return type

ConstructNode

path

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

Stability

experimental

Return type

Optional[str]

route_id

(experimental) Id of the Route.

Stability

experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

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