software.amazon.awscdk.services.apigatewayv2.alpha

Interface IHttpRoute.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IHttpRoute, IResource, IResource.Jsii$Default, IRoute, IRoute.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IHttpRoute.Jsii$Proxy

Enclosing interface:

IHttpRoute

@Internal
public static interface IHttpRoute.Jsii$Default
extends IHttpRoute, IRoute.Jsii$Default

Internal default implementation for IHttpRoute.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.alpha.IHttpRoute

IHttpRoute.Jsii$Default, IHttpRoute.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default IHttpApi	getHttpApi() (experimental) The HTTP API associated with this route.
default software.constructs.Node	getNode() The tree node.
default String	getPath() (experimental) Returns the path component of this HTTP route, `undefined` if the path is the catch-all route.
default String	getRouteArn() (experimental) Returns the arn of the route.
default String	getRouteId() (experimental) Id of the Route.
default Stack	getStack() The stack in which this resource is defined.
default Grant	grantInvoke(IGrantable grantee, GrantInvokeOptions options) (experimental) Grant access to invoke the route.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.alpha.IHttpRoute

grantInvoke

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IRoute.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment 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 interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IRoute.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IRoute.Jsii$Default

getRouteId

@Stability(value=Experimental)
 @NotNull
default String getRouteId()

(experimental) Id of the Route.

Specified by:

getRouteId in interface IRoute

Specified by:

getRouteId in interface IRoute.Jsii$Default

getHttpApi

@Stability(value=Experimental)
 @NotNull
default IHttpApi getHttpApi()

(experimental) The HTTP API associated with this route.

Specified by:

getHttpApi in interface IHttpRoute

getRouteArn

@Stability(value=Experimental)
 @NotNull
default String getRouteArn()

(experimental) Returns the arn of the route.

Specified by:

getRouteArn in interface IHttpRoute

getPath

@Stability(value=Experimental)
 @Nullable
default String getPath()

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

Specified by:

getPath in interface IHttpRoute

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy 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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IRoute.Jsii$Default

Parameters:

policy - This parameter is required.

grantInvoke

@Stability(value=Experimental)
 @NotNull
default Grant grantInvoke(@NotNull
                                                                   IGrantable grantee,
                                                                   @Nullable
                                                                   GrantInvokeOptions options)

(experimental) 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 interface IHttpRoute

Parameters:

grantee - This parameter is required.

options -