software.amazon.awscdk.services.apigateway

Class Integration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.Integration

Direct Known Subclasses:

AwsIntegration, HttpIntegration, MockIntegration

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.218Z")
public class Integration
extends software.amazon.jsii.JsiiObject

Base class for backend integrations for an API Gateway method.

Use one of the concrete classes such as MockIntegration, AwsIntegration, LambdaIntegration or implement on your own by specifying the set of props.

Example:

 Resource books;
 User iamUser;
 Method getBooks = books.addMethod("GET", new HttpIntegration("http://amazon.com"), MethodOptions.builder()
         .authorizationType(AuthorizationType.IAM)
         .build());
 iamUser.attachInlinePolicy(Policy.Builder.create(this, "AllowBooks")
         .statements(List.of(
             PolicyStatement.Builder.create()
                     .actions(List.of("execute-api:Invoke"))
                     .effect(Effect.ALLOW)
                     .resources(List.of(getBooks.getMethodArn()))
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Integration.Builder A fluent builder for Integration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Integration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Integration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IntegrationConfig	bind(Method _method) Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Integration

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

Integration

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

Method Detail

bind

public IntegrationConfig bind(Method _method)

Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc.

Parameters:

_method - This parameter is required.