Package software.amazon.awscdk.services.apigatewayv2

Interface CfnIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:12.014Z")
@Stability(Stable)
public interface CfnIntegrationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIntegration.

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;
 CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIntegrationProps.Builder	builder()
String	getApiId()	The API identifier.
default String	getConnectionId()	The ID of the VPC link for a private integration.
default String	getConnectionType()	The type of the network connection to the integration endpoint.
default String	getContentHandlingStrategy()	Supported only for WebSocket APIs.
default String	getCredentialsArn()	Specifies the credentials required for the integration, if any.
default String	getDescription()	The description of the integration.
default String	getIntegrationMethod()	Specifies the integration's HTTP method type.
default String	getIntegrationSubtype()	Supported only for HTTP API AWS_PROXY integrations.
String	getIntegrationType()	The integration type of an integration.
default String	getIntegrationUri()	For a Lambda integration, specify the URI of a Lambda function.
default 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.
default String	getPayloadFormatVersion()	Specifies the format of the payload sent to an integration.
default Object	getRequestParameters()	For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
default 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.
default Object	getResponseParameters()	Supported only for HTTP APIs.
default String	getTemplateSelectionExpression()	The template selection expression for the integration.
default Number	getTimeoutInMillis()	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
default Object	getTlsConfig()	The TLS configuration for a private integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid

getIntegrationType

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype

getConnectionId

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

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectionid

getConnectionType

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype

getContentHandlingStrategy

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy

getCredentialsArn

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn

getDescription

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

The description of the integration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description

getIntegrationMethod

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

Specifies the integration's HTTP method type.

For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod

getIntegrationSubtype

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

Supported only for HTTP API AWS_PROXY integrations.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationsubtype

getIntegrationUri

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri

getPassthroughBehavior

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior

getPayloadFormatVersion

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion

getRequestParameters

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters

getRequestTemplates

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates

getResponseParameters

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-responseparameters

getTemplateSelectionExpression

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

The template selection expression for the integration.

Supported only for WebSocket APIs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression

getTimeoutInMillis

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis

getTlsConfig

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-tlsconfig

builder

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

Returns:

a CfnIntegrationProps.Builder of CfnIntegrationProps