Package software.amazon.awscdk.services.apigateway

Interface IntegrationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IntegrationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.002Z")
@Stability(Stable)
public interface IntegrationConfig
extends software.amazon.jsii.JsiiSerializable

Result of binding an Integration to a Method.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 VpcLink vpcLink;
 IntegrationConfig integrationConfig = IntegrationConfig.builder()
         .type(IntegrationType.AWS)
         // the properties below are optional
         .deploymentToken("deploymentToken")
         .integrationHttpMethod("integrationHttpMethod")
         .options(IntegrationOptions.builder()
                 .cacheKeyParameters(List.of("cacheKeyParameters"))
                 .cacheNamespace("cacheNamespace")
                 .connectionType(ConnectionType.INTERNET)
                 .contentHandling(ContentHandling.CONVERT_TO_BINARY)
                 .credentialsPassthrough(false)
                 .credentialsRole(role)
                 .integrationResponses(List.of(IntegrationResponse.builder()
                         .statusCode("statusCode")
                         // the properties below are optional
                         .contentHandling(ContentHandling.CONVERT_TO_BINARY)
                         .responseParameters(Map.of(
                                 "responseParametersKey", "responseParameters"))
                         .responseTemplates(Map.of(
                                 "responseTemplatesKey", "responseTemplates"))
                         .selectionPattern("selectionPattern")
                         .build()))
                 .passthroughBehavior(PassthroughBehavior.WHEN_NO_MATCH)
                 .requestParameters(Map.of(
                         "requestParametersKey", "requestParameters"))
                 .requestTemplates(Map.of(
                         "requestTemplatesKey", "requestTemplates"))
                 .timeout(Duration.minutes(30))
                 .vpcLink(vpcLink)
                 .build())
         .uri("uri")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IntegrationConfig.Builder	A builder for IntegrationConfig
static final class	IntegrationConfig.Jsii$Proxy	An implementation for IntegrationConfig

Method Summary

Modifier and Type	Method	Description
static IntegrationConfig.Builder	builder()
default String	getDeploymentToken()	This value is included in computing the Deployment's fingerprint.
default String	getIntegrationHttpMethod()	The integration's HTTP method type.
default IntegrationOptions	getOptions()	Integration options.
IntegrationType	getType()	Specifies an API method integration type.
default String	getUri()	The Uniform Resource Identifier (URI) for the integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
IntegrationType getType()

Specifies an API method integration type.

getDeploymentToken

@Stability(Stable)
@Nullable
default String getDeploymentToken()

This value is included in computing the Deployment's fingerprint.

When the fingerprint changes, a new deployment is triggered. This property should contain values associated with the Integration that upon changing should trigger a fresh the Deployment needs to be refreshed.

Default: undefined deployments are not triggered for any change to this integration.

getIntegrationHttpMethod

@Stability(Stable)
@Nullable
default String getIntegrationHttpMethod()

The integration's HTTP method type.

Required unless you use a MOCK integration.

Default: - no integration method specified.

getOptions

@Stability(Stable)
@Nullable
default IntegrationOptions getOptions()

Integration options.

Default: - no integration options

getUri

@Stability(Stable)
@Nullable
default String getUri()

The Uniform Resource Identifier (URI) for the integration.

Default: - no URI. Usually applies to MOCK integration

See Also:

• https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri

builder

@Stability(Stable)
static IntegrationConfig.Builder builder()

Returns:

a IntegrationConfig.Builder of IntegrationConfig