Class HttpIntegration
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
public class HttpIntegration : Integration
- Inheritance
-
HttpIntegration
- Inherited Members
Examples
Function authFn;
Resource books;
var auth = new RequestAuthorizer(this, "booksAuthorizer", new RequestAuthorizerProps {
Handler = authFn,
IdentitySources = new [] { IdentitySource.Header("Authorization") }
});
books.AddMethod("GET", new HttpIntegration("http://amazon.com"), new MethodOptions {
Authorizer = auth
});
Remarks
With the proxy integration, the setup is simple. You only need to set the HTTP method and the HTTP endpoint URI, according to the backend requirements, if you are not concerned with content encoding or caching.
With the custom integration, the setup is more involved. In addition to the proxy integration setup steps, you need to specify how the incoming request data is mapped to the integration request and how the resulting integration response data is mapped to the method response.
ExampleMetadata: infused
Constructors
HttpIntegration(string, IHttpIntegrationProps?)
public HttpIntegration(string url, IHttpIntegrationProps? props = null)
Parameters
url
stringprops
IHttpIntegrationProps