software.amazon.awscdk.services.apigateway

Class Integration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.Integration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AwsIntegration, HttpIntegration, MockIntegration

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.170Z")
 @Stability(value=Stable)
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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Integration(IntegrationProps props)
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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Integration

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

Integration

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

Integration

@Stability(value=Stable)
public Integration(@NotNull
                                            IntegrationProps props)

Parameters:

props - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public IntegrationConfig bind(@NotNull
                                                                 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.