Package software.amazon.awscdk.services.apigatewayv2

Class IHttpRoute.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.IHttpRoute.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IHttpRoute

@Internal
public static final class IHttpRoute.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IHttpRoute.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

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.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, 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.core.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

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IHttpRoute.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IRoute.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final 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 IHttpRoute.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IRoute.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IHttpRoute.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IRoute.Jsii$Default

getRouteId

@Stability(Experimental)
@NotNull
public final String getRouteId()

(experimental) Id of the Route.

Specified by:

getRouteId in interface IHttpRoute.Jsii$Default

Specified by:

getRouteId in interface IRoute

Specified by:

getRouteId in interface IRoute.Jsii$Default

getHttpApi

@Stability(Experimental)
@NotNull
public final IHttpApi getHttpApi()

(experimental) The HTTP API associated with this route.

Specified by:

getHttpApi in interface IHttpRoute

Specified by:

getHttpApi in interface IHttpRoute.Jsii$Default

getRouteArn

@Stability(Experimental)
@NotNull
public final String getRouteArn()

(experimental) Returns the arn of the route.

Specified by:

getRouteArn in interface IHttpRoute

Specified by:

getRouteArn in interface IHttpRoute.Jsii$Default

getPath

@Stability(Experimental)
@Nullable
public final 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

Specified by:

getPath in interface IHttpRoute.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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 IHttpRoute.Jsii$Default

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(Experimental)
@NotNull
public final 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

Specified by:

grantInvoke in interface IHttpRoute.Jsii$Default

Parameters:

grantee - This parameter is required.

options -

grantInvoke

@Stability(Experimental)
@NotNull
public final Grant grantInvoke(@NotNull
 IGrantable grantee)

(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.