Class HttpRouteIntegration
The interface that various route integration classes will inherit.
Inheritance
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class HttpRouteIntegration : DeputyBase
Syntax (vb)
Public MustInherit Class HttpRouteIntegration
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.HttpAlbIntegration;
ApplicationLoadBalancer lb;
var listener = lb.AddListener("listener", new BaseApplicationListenerProps { Port = 80 });
listener.AddTargets("target", new AddApplicationTargetsProps {
Port = 80
});
var httpEndpoint = new HttpApi(this, "HttpProxyPrivateApi", new HttpApiProps {
DefaultIntegration = new HttpAlbIntegration("DefaultIntegration", listener, new HttpAlbIntegrationProps {
ParameterMapping = new ParameterMapping().Custom("myKey", "myValue")
})
});
Synopsis
Constructors
HttpRouteIntegration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
HttpRouteIntegration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
HttpRouteIntegration(String) | Initialize an integration for a route on http api. |
Methods
Bind(IHttpRouteIntegrationBindOptions) | Bind this integration to the route. |
CompleteBind(IHttpRouteIntegrationBindOptions) | Complete the binding of the integration to the route. |
Constructors
HttpRouteIntegration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected HttpRouteIntegration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
HttpRouteIntegration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected HttpRouteIntegration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
HttpRouteIntegration(String)
Initialize an integration for a route on http api.
protected HttpRouteIntegration(string id)
Parameters
- id System.String
id of the underlying
HttpIntegration
construct.
Methods
Bind(IHttpRouteIntegrationBindOptions)
Bind this integration to the route.
public abstract IHttpRouteIntegrationConfig Bind(IHttpRouteIntegrationBindOptions options)
Parameters
- options IHttpRouteIntegrationBindOptions
Returns
CompleteBind(IHttpRouteIntegrationBindOptions)
Complete the binding of the integration to the route.
protected virtual void CompleteBind(IHttpRouteIntegrationBindOptions options)
Parameters
- options IHttpRouteIntegrationBindOptions
Remarks
In some cases, there is some additional work to do, such as adding permissions for the API to access the target. This work is necessary whether the integration has just been created for this route or it is an existing one, previously created for other routes. In most cases, however, concrete implementations do not need to override this method.