Package software.amazon.awscdk.services.apigatewayv2

Class CfnIntegration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnIntegration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.188Z") @Stability(Stable) public class CfnIntegration extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Integration.

The AWS::ApiGatewayV2::Integration resource creates an integration for an API.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 Object requestParameters;
 Object requestTemplates;
 Object responseParameters;
 CfnIntegration cfnIntegration = CfnIntegration.Builder.create(this, "MyCfnIntegration")
         .apiId("apiId")
         .integrationType("integrationType")
         // the properties below are optional
         .connectionId("connectionId")
         .connectionType("connectionType")
         .contentHandlingStrategy("contentHandlingStrategy")
         .credentialsArn("credentialsArn")
         .description("description")
         .integrationMethod("integrationMethod")
         .integrationSubtype("integrationSubtype")
         .integrationUri("integrationUri")
         .passthroughBehavior("passthroughBehavior")
         .payloadFormatVersion("payloadFormatVersion")
         .requestParameters(requestParameters)
         .requestTemplates(requestTemplates)
         .responseParameters(responseParameters)
         .templateSelectionExpression("templateSelectionExpression")
         .timeoutInMillis(123)
         .tlsConfig(TlsConfigProperty.builder()
                 .serverNameToVerify("serverNameToVerify")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnIntegration

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

    • CfnIntegration

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

    • CfnIntegration

      @Stability(Stable) public CfnIntegration(@NotNull Construct scope, @NotNull String id, @NotNull CfnIntegrationProps props)
      Create a new AWS::ApiGatewayV2::Integration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getIntegrationType

      @Stability(Stable) @NotNull public String getIntegrationType()
      The integration type of an integration. One of the following:.

      AWS : for integrating the route or 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. Supported only for WebSocket APIs.

      AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

      HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

      HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

      MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    • setIntegrationType

      @Stability(Stable) public void setIntegrationType(@NotNull String value)
      The integration type of an integration. One of the following:.

      AWS : for integrating the route or 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. Supported only for WebSocket APIs.

      AWS_PROXY : for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.

      HTTP : for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.

      HTTP_PROXY : for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.

      MOCK : for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.

    • getRequestParameters

      @Stability(Stable) @NotNull public Object getRequestParameters()
      For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

      The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

      For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

      For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

    • setRequestParameters

      @Stability(Stable) public void setRequestParameters(@NotNull Object value)
      For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

      The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request. {location} . {name} , where {location} is querystring , path , or header ; and {name} must be a valid and unique method request parameter name.

      For HTTP API integrations with a specified integrationSubtype , request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs .

      For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern :<header|querystring|path>. where action can be append , overwrite or remove . For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses .

    • getRequestTemplates

      @Stability(Stable) @NotNull public Object getRequestTemplates()
      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.

      The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

    • setRequestTemplates

      @Stability(Stable) public void setRequestTemplates(@NotNull Object value)
      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.

      The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.

    • getResponseParameters

      @Stability(Stable) @NotNull public Object getResponseParameters()
      Supported only for HTTP APIs.

      You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

    • setResponseParameters

      @Stability(Stable) public void setResponseParameters(@NotNull Object value)
      Supported only for HTTP APIs.

      You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. The value is of type ResponseParameterList . To learn more, see Transforming API requests and responses .

    • getConnectionId

      @Stability(Stable) @Nullable public String getConnectionId()
      The ID of the VPC link for a private integration.

      Supported only for HTTP APIs.

    • setConnectionId

      @Stability(Stable) public void setConnectionId(@Nullable String value)
      The ID of the VPC link for a private integration.

      Supported only for HTTP APIs.

    • getConnectionType

      @Stability(Stable) @Nullable public String getConnectionType()
      The type of the network connection to the integration endpoint.

      Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .

    • setConnectionType

      @Stability(Stable) public void setConnectionType(@Nullable String value)
      The type of the network connection to the integration endpoint.

      Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET .

    • getContentHandlingStrategy

      @Stability(Stable) @Nullable public String getContentHandlingStrategy()
      Supported only for WebSocket APIs.

      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

      CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • setContentHandlingStrategy

      @Stability(Stable) public void setContentHandlingStrategy(@Nullable String value)
      Supported only for WebSocket APIs.

      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors:

      CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob.

      CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string.

      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.

    • getCredentialsArn

      @Stability(Stable) @Nullable public String getCredentialsArn()
      Specifies the credentials required for the integration, if any.

      For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.

    • setCredentialsArn

      @Stability(Stable) public void setCredentialsArn(@Nullable String value)
      Specifies the credentials required for the integration, if any.

      For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/* . To use resource-based permissions on supported AWS services, don't specify this parameter.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the integration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the integration.

    • getIntegrationMethod

      @Stability(Stable) @Nullable public String getIntegrationMethod()
      Specifies the integration's HTTP method type.

    • setIntegrationMethod

      @Stability(Stable) public void setIntegrationMethod(@Nullable String value)
      Specifies the integration's HTTP method type.

    • getIntegrationSubtype

      @Stability(Stable) @Nullable public String getIntegrationSubtype()
      Supported only for HTTP API AWS_PROXY integrations.

      Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .

    • setIntegrationSubtype

      @Stability(Stable) public void setIntegrationSubtype(@Nullable String value)
      Supported only for HTTP API AWS_PROXY integrations.

      Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .

    • getIntegrationUri

      @Stability(Stable) @Nullable public String getIntegrationUri()
      For a Lambda integration, specify the URI of a Lambda function.

      For an HTTP integration, specify a fully-qualified URL.

      For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    • setIntegrationUri

      @Stability(Stable) public void setIntegrationUri(@Nullable String value)
      For a Lambda integration, specify the URI of a Lambda function.

      For an HTTP integration, specify a fully-qualified URL.

      For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances . For private integrations, all resources must be owned by the same AWS account .

    • getPassthroughBehavior

      @Stability(Stable) @Nullable public String getPassthroughBehavior()
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

      There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

      WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

      NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

      WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    • setPassthroughBehavior

      @Stability(Stable) public void setPassthroughBehavior(@Nullable String value)
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

      There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . Supported only for WebSocket APIs.

      WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

      NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

      WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

    • getPayloadFormatVersion

      @Stability(Stable) @Nullable public String getPayloadFormatVersion()
      Specifies the format of the payload sent to an integration.

      Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .

    • setPayloadFormatVersion

      @Stability(Stable) public void setPayloadFormatVersion(@Nullable String value)
      Specifies the format of the payload sent to an integration.

      Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 . For all other integrations, 1.0 is the only supported value. To learn more, see Working with AWS Lambda proxy integrations for HTTP APIs .

    • getTemplateSelectionExpression

      @Stability(Stable) @Nullable public String getTemplateSelectionExpression()
      The template selection expression for the integration.

      Supported only for WebSocket APIs.

    • setTemplateSelectionExpression

      @Stability(Stable) public void setTemplateSelectionExpression(@Nullable String value)
      The template selection expression for the integration.

      Supported only for WebSocket APIs.

    • getTimeoutInMillis

      @Stability(Stable) @Nullable public Number getTimeoutInMillis()
      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

      The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    • setTimeoutInMillis

      @Stability(Stable) public void setTimeoutInMillis(@Nullable Number value)
      Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.

      The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.

    • getTlsConfig

      @Stability(Stable) @Nullable public Object getTlsConfig()
      The TLS configuration for a private integration.

      If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable IResolvable value)
      The TLS configuration for a private integration.

      If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable CfnIntegration.TlsConfigProperty value)
      The TLS configuration for a private integration.

      If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.