software.amazon.awscdk.services.apigatewayv2

Class HttpRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.HttpRoute

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.421Z")
 @Stability(value=Experimental)
public class HttpRoute
extends Resource
implements IHttpRoute

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRoute.Builder (experimental) A fluent builder for HttpRoute.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IHttpRoute.Jsii$Default, IHttpRoute.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	HttpRoute(software.constructs.Construct scope, String id, HttpRouteProps props)
protected	HttpRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HttpRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IHttpApi	getHttpApi() (experimental) The HTTP API associated with this route.
String	getPath() (experimental) Returns the path component of this HTTP route, `undefined` if the path is the catch-all route.
String	getRouteId() (experimental) Id of the Route.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

HttpRoute

protected HttpRoute(software.amazon.jsii.JsiiObjectRef objRef)

HttpRoute

protected HttpRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HttpRoute

@Stability(value=Experimental)
public HttpRoute(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                HttpRouteProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getHttpApi

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

(experimental) The HTTP API associated with this route.

Specified by:

getHttpApi in interface IHttpRoute

getRouteId

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

(experimental) Id of the Route.

Specified by:

getRouteId in interface IRoute

getPath

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