HttpRoute L2 construct
Route class that creates the Route for API Gateway HTTP API.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const httpApiRef: apigatewayv2.IHttpApiRef;
declare const httpRouteAuthorizer: apigatewayv2.IHttpRouteAuthorizer;
declare const httpRouteIntegration: apigatewayv2.HttpRouteIntegration;
declare const httpRouteKey: apigatewayv2.HttpRouteKey;
const httpRoute = new apigatewayv2.HttpRoute(this, 'MyHttpRoute', {
httpApi: httpApiRef,
integration: httpRouteIntegration,
routeKey: httpRouteKey,
// the properties below are optional
authorizationScopes: ['authorizationScopes'],
authorizer: httpRouteAuthorizer,
});
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2
# http_api_ref: apigatewayv2.IHttpApiRef
# http_route_authorizer: apigatewayv2.IHttpRouteAuthorizer
# http_route_integration: apigatewayv2.HttpRouteIntegration
# http_route_key: apigatewayv2.HttpRouteKey
http_route = apigatewayv2.HttpRoute(self, "MyHttpRoute",
http_api=http_api_ref,
integration=http_route_integration,
route_key=http_route_key,
# the properties below are optional
authorization_scopes=["authorizationScopes"],
authorizer=http_route_authorizer
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apigatewayv2.*;
IHttpApiRef httpApiRef;
IHttpRouteAuthorizer httpRouteAuthorizer;
HttpRouteIntegration httpRouteIntegration;
HttpRouteKey httpRouteKey;
HttpRoute httpRoute = HttpRoute.Builder.create(this, "MyHttpRoute")
.httpApi(httpApiRef)
.integration(httpRouteIntegration)
.routeKey(httpRouteKey)
// the properties below are optional
.authorizationScopes(List.of("authorizationScopes"))
.authorizer(httpRouteAuthorizer)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
IHttpApiRef httpApiRef;
IHttpRouteAuthorizer httpRouteAuthorizer;
HttpRouteIntegration httpRouteIntegration;
HttpRouteKey httpRouteKey;
var httpRoute = new HttpRoute(this, "MyHttpRoute", new HttpRouteProps {
HttpApi = httpApiRef,
Integration = httpRouteIntegration,
RouteKey = httpRouteKey,
// the properties below are optional
AuthorizationScopes = new [] { "authorizationScopes" },
Authorizer = httpRouteAuthorizer
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var httpApiRef IHttpApiRef
var httpRouteAuthorizer IHttpRouteAuthorizer
var httpRouteIntegration HttpRouteIntegration
var httpRouteKey HttpRouteKey
httpRoute := awscdk.Aws_apigatewayv2.NewHttpRoute(this, jsii.String("MyHttpRoute"), &HttpRouteProps{
HttpApi: httpApiRef,
Integration: httpRouteIntegration,
RouteKey: httpRouteKey,
// the properties below are optional
AuthorizationScopes: []*string{
jsii.String("authorizationScopes"),
},
Authorizer: httpRouteAuthorizer,
})
Initializer
new HttpRoute(scope: Construct, id: string, props: HttpRouteProps)
HttpRoute(scope: Construct, id: str, props: HttpRouteProps)
new HttpRoute(Construct scope, String id, HttpRouteProps props)
new HttpRoute(Construct scope, string id, HttpRouteProps props)
NewHttpRoute(Scope Construct, Id *string, Props HttpRouteProps)
Construct Props
authorizationScopesstring[]authorization_scopestyping.List[str]authorizationScopesList<String>AuthorizationScopesstring[]AuthorizationScopes*[]*string= no additional authorization scop…#These scopes will be merged with the scopes from the attached authorizer
default
Default: no additional authorization scopes
authorizerIHttpRouteAuthorizerauthorizerIHttpRouteAuthorizerauthorizerIHttpRouteAuthorizerAuthorizerIHttpRouteAuthorizerAuthorizerIHttpRouteAuthorizer= No authorizer#httpApiIHttpApiRefhttp_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRefrequired#integrationHttpRouteIntegrationintegrationHttpRouteIntegrationintegrationHttpRouteIntegrationIntegrationHttpRouteIntegrationIntegrationHttpRouteIntegrationrequired#routeKeyHttpRouteKeyroute_keyHttpRouteKeyrouteKeyHttpRouteKeyRouteKeyHttpRouteKeyRouteKeyHttpRouteKeyrequired#This is a combination of an HTTP method and an HTTP path.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#routeRefRouteReferenceroute_refRouteReferencerouteRefRouteReferenceRouteRefRouteReferenceRouteRefRouteReferencerequired#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
grantInvoke(grantee: IGrantable, options?: GrantInvokeOptions): Grantdef grant_invoke(self, grantee: IGrantable, options: typing.Optional[GrantInvokeOptions] = None) -> Grantpublic Grant grantInvoke(IGrantable grantee, GrantInvokeOptions options)public Grant GrantInvoke(IGrantable grantee, GrantInvokeOptions? options = null)func GrantInvoke(Grantee IGrantable, Options GrantInvokeOptions) Grant#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.