Class IHttpRoute.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IHttpRoute
,IHttpRoute.Jsii$Default
,IRoute
,IRoute.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IHttpRoute
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IHttpRoute
IHttpRoute.Jsii$Default, IHttpRoute.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IRoute
IRoute.Jsii$Default, IRoute.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final IHttpApi
The HTTP API associated with this route.final software.constructs.Node
getNode()
The tree node.final String
getPath()
Returns the path component of this HTTP route,undefined
if the path is the catch-all route.final String
Returns the arn of the route.final String
Id of the Route.final Stack
getStack()
The stack in which this resource is defined.final Grant
grantInvoke
(IGrantable grantee) Grant access to invoke the route.final Grant
grantInvoke
(IGrantable grantee, GrantInvokeOptions options) Grant access to invoke the route.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIHttpRoute.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIRoute.Jsii$Default
-
getEnv
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.
- Specified by:
getEnv
in interfaceIHttpRoute.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIRoute.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIHttpRoute.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIRoute.Jsii$Default
-
getRouteId
Id of the Route.- Specified by:
getRouteId
in interfaceIHttpRoute.Jsii$Default
- Specified by:
getRouteId
in interfaceIRoute
- Specified by:
getRouteId
in interfaceIRoute.Jsii$Default
-
getHttpApi
The HTTP API associated with this route.- Specified by:
getHttpApi
in interfaceIHttpRoute
- Specified by:
getHttpApi
in interfaceIHttpRoute.Jsii$Default
-
getRouteArn
Returns the arn of the route.- Specified by:
getRouteArn
in interfaceIHttpRoute
- Specified by:
getRouteArn
in interfaceIHttpRoute.Jsii$Default
-
getPath
Returns the path component of this HTTP route,undefined
if the path is the catch-all route.- Specified by:
getPath
in interfaceIHttpRoute
- Specified by:
getPath
in interfaceIHttpRoute.Jsii$Default
-
applyRemovalPolicy
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
).- Specified by:
applyRemovalPolicy
in interfaceIHttpRoute.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIRoute.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grantInvoke
@Stability(Stable) @NotNull public final Grant grantInvoke(@NotNull IGrantable grantee, @Nullable GrantInvokeOptions options) Grant access to invoke the route.This method requires that the authorizer of the route is undefined or is an
HttpIamAuthorizer
.- Specified by:
grantInvoke
in interfaceIHttpRoute
- Specified by:
grantInvoke
in interfaceIHttpRoute.Jsii$Default
- Parameters:
grantee
- This parameter is required.options
-
-
grantInvoke
Grant access to invoke the route.This method requires that the authorizer of the route is undefined or is an
HttpIamAuthorizer
.- Specified by:
grantInvoke
in interfaceIHttpRoute
- Parameters:
grantee
- This parameter is required.
-