Package software.amazon.awscdk.services.apigateway

Enum IntegrationType

java.lang.Object
java.lang.Enum<IntegrationType>
software.amazon.awscdk.services.apigateway.IntegrationType
All Implemented Interfaces:
Serializable, Comparable<IntegrationType>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:24.878Z") @Stability(Stable) public enum IntegrationType extends Enum<IntegrationType>
Example: 

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer nlb = NetworkLoadBalancer.Builder.create(this, "NLB")
         .vpc(vpc)
         .build();
 VpcLink link = VpcLink.Builder.create(this, "link")
         .targets(List.of(nlb))
         .build();
 Integration integration = Integration.Builder.create()
         .type(IntegrationType.HTTP_PROXY)
         .integrationHttpMethod("ANY")
         .options(IntegrationOptions.builder()
                 .connectionType(ConnectionType.VPC_LINK)
                 .vpcLink(link)
                 .build())
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AWS
    For integrating the API method request with an AWS service action, including the Lambda function-invoking action.
    AWS_PROXY
    For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is.
    HTTP
    For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC.
    HTTP_PROXY
    For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is.
    MOCK
    For integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

  • Method Summary

    Modifier and Type
    Method
    Description
    static IntegrationType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static IntegrationType[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • AWS

      @Stability(Stable) public static final IntegrationType AWS
      For integrating the API method request with an AWS service action, including the Lambda function-invoking action.

      With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

    • AWS_PROXY

      @Stability(Stable) public static final IntegrationType AWS_PROXY
      For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is.

      This integration is also referred to as the Lambda proxy integration

    • HTTP

      @Stability(Stable) public static final IntegrationType HTTP
      For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC.

      This integration is also referred to as the HTTP custom integration.

    • HTTP_PROXY

      @Stability(Stable) public static final IntegrationType HTTP_PROXY
      For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is.

      This is also referred to as the HTTP proxy integration

    • MOCK

      @Stability(Stable) public static final IntegrationType MOCK
      For integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

  • Method Details

    • values

      public static IntegrationType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static IntegrationType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null