Class HttpRouteProps

(experimental) Properties to initialize a new Route.

Inheritance
System.Object
HttpRouteProps
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class HttpRouteProps : Object, IHttpRouteProps, IBatchHttpRouteOptions
Syntax (vb)
Public Class HttpRouteProps
    Inherits Object
    Implements IHttpRouteProps, IBatchHttpRouteOptions
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;

HttpApi httpApi;
IHttpRouteAuthorizer httpRouteAuthorizer;
HttpRouteIntegration httpRouteIntegration;
HttpRouteKey httpRouteKey;

var httpRouteProps = new HttpRouteProps {
    HttpApi = httpApi,
    Integration = httpRouteIntegration,
    RouteKey = httpRouteKey,

    // the properties below are optional
    AuthorizationScopes = new [] { "authorizationScopes" },
    Authorizer = httpRouteAuthorizer
};

Synopsis

Constructors

HttpRouteProps()

Properties

AuthorizationScopes

(experimental) The list of OIDC scopes to include in the authorization.
Authorizer

(experimental) Authorizer for a WebSocket API or an HTTP API.
HttpApi

(experimental) the API the route is associated with.
Integration

(experimental) The integration to be configured on this route.
RouteKey

(experimental) The key to this route.

Constructors

HttpRouteProps()

public HttpRouteProps()

Properties

AuthorizationScopes

(experimental) The list of OIDC scopes to include in the authorization.

public string[] AuthorizationScopes { get; set; }
Property Value

System.String[]

Remarks

These scopes will be merged with the scopes from the attached authorizer

Default: - no additional authorization scopes

Stability: Experimental

Authorizer

(experimental) Authorizer for a WebSocket API or an HTTP API.

public IHttpRouteAuthorizer Authorizer { get; set; }
Property Value

IHttpRouteAuthorizer

Remarks

Default: - No authorizer

Stability: Experimental

HttpApi

(experimental) the API the route is associated with.

public IHttpApi HttpApi { get; set; }
Property Value

IHttpApi

Remarks

Stability: Experimental

Integration

(experimental) The integration to be configured on this route.

public HttpRouteIntegration Integration { get; set; }
Property Value

HttpRouteIntegration

Remarks

Stability: Experimental

RouteKey

(experimental) The key to this route.

public HttpRouteKey RouteKey { get; set; }
Property Value

HttpRouteKey

Remarks

This is a combination of an HTTP method and an HTTP path.

Stability: Experimental

Implements