IHttpRoute
- class aws_cdk.aws_apigatewayv2.IHttpRoute(*args, **kwargs)
Bases:
IRoute
,Protocol
Represents a Route for an HTTP API.
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:
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.
- Attribute:
true
- route_id
Id of the Route.
- Attribute:
true
- stack
The stack in which this resource is defined.