Interface HttpIntegrationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
HttpIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.758Z") @Stability(Stable) public interface HttpIntegrationProps extends software.amazon.jsii.JsiiSerializable
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;
 HttpIntegrationProps httpIntegrationProps = HttpIntegrationProps.builder()
         .httpMethod("httpMethod")
         .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())
         .proxy(false)
         .build();
 
  • Method Details

    • getHttpMethod

      @Stability(Stable) @Nullable default String getHttpMethod()
      HTTP method to use when invoking the backend URL.

      Default: GET

    • getOptions

      @Stability(Stable) @Nullable default IntegrationOptions getOptions()
      Integration options, such as request/resopnse mapping, content handling, etc.

      Default: defaults based on `IntegrationOptions` defaults

    • getProxy

      @Stability(Stable) @Nullable default Boolean getProxy()
      Determines whether to use proxy integration or custom integration.

      Default: true

    • builder

      @Stability(Stable) static HttpIntegrationProps.Builder builder()
      Returns:
      a HttpIntegrationProps.Builder of HttpIntegrationProps