Package software.amazon.awscdk.services.apigatewayv2

Class CfnIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnIntegration

All Implemented Interfaces:

IInspectable, IIntegrationRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:44.495Z")
@Stability(Stable)
public class CfnIntegration
extends CfnResource
implements IInspectable, IIntegrationRef

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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnIntegration.Builder	A fluent builder for CfnIntegration.
static interface	CfnIntegration.ResponseParameterListProperty	Example:
static interface	CfnIntegration.ResponseParameterMapProperty	map of response parameter lists.
static interface	CfnIntegration.ResponseParameterProperty	Supported only for HTTP APIs.
static interface	CfnIntegration.TlsConfigProperty	The TlsConfig property specifies the TLS configuration for a private integration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.apigatewayv2.IIntegrationRef

IIntegrationRef.Jsii$Default, IIntegrationRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIntegration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnIntegration(software.constructs.Construct scope, String id, CfnIntegrationProps props)	Create a new AWS::ApiGatewayV2::Integration.

Method Summary

Modifier and Type	Method	Description
String	getApiId()	The API identifier.
String	getAttrIntegrationId()	The integration ID.
protected Map<String,Object>	getCfnProperties()
String	getConnectionId()	The ID of the VPC link for a private integration.
String	getConnectionType()	The type of the network connection to the integration endpoint.
String	getContentHandlingStrategy()	Supported only for WebSocket APIs.
String	getCredentialsArn()	Specifies the credentials required for the integration, if any.
String	getDescription()	The description of the integration.
String	getIntegrationMethod()	Specifies the integration's HTTP method type.
IntegrationReference	getIntegrationRef()	A reference to a Integration resource.
String	getIntegrationSubtype()	Supported only for HTTP API AWS_PROXY integrations.
String	getIntegrationType()	The integration type of an integration.
String	getIntegrationUri()	For a Lambda integration, specify the URI of a Lambda function.
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.
String	getPayloadFormatVersion()	Specifies the format of the payload sent to an integration.
Object	getRequestParameters()	For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
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.
Object	getResponseParameters()	Supported only for HTTP APIs.
String	getTemplateSelectionExpression()	The template selection expression for the integration.
Number	getTimeoutInMillis()	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
Object	getTlsConfig()	The TLS configuration for a private integration.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value)	The API identifier.
void	setConnectionId(String value)	The ID of the VPC link for a private integration.
void	setConnectionType(String value)	The type of the network connection to the integration endpoint.
void	setContentHandlingStrategy(String value)	Supported only for WebSocket APIs.
void	setCredentialsArn(String value)	Specifies the credentials required for the integration, if any.
void	setDescription(String value)	The description of the integration.
void	setIntegrationMethod(String value)	Specifies the integration's HTTP method type.
void	setIntegrationSubtype(String value)	Supported only for HTTP API AWS_PROXY integrations.
void	setIntegrationType(String value)	The integration type of an integration.
void	setIntegrationUri(String value)	For a Lambda integration, specify the URI of a Lambda function.
void	setPassthroughBehavior(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.
void	setPayloadFormatVersion(String value)	Specifies the format of the payload sent to an integration.
void	setRequestParameters(Object value)	For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
void	setRequestTemplates(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.
void	setResponseParameters(Object value)	Supported only for HTTP APIs.
void	setTemplateSelectionExpression(String value)	The template selection expression for the integration.
void	setTimeoutInMillis(Number value)	Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
void	setTlsConfig(IResolvable value)	The TLS configuration for a private integration.
void	setTlsConfig(CfnIntegration.TlsConfigProperty value)	The TLS configuration for a private integration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.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 - Construct identifier for this resource (unique in its scope). 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.

getAttrIntegrationId

@Stability(Stable)
@NotNull
public String getAttrIntegrationId()

The integration ID.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getIntegrationRef

@Stability(Stable)
@NotNull
public IntegrationReference getIntegrationRef()

A reference to a Integration resource.

Specified by:

getIntegrationRef in interface IIntegrationRef

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:.

setIntegrationType

@Stability(Stable)
public void setIntegrationType(@NotNull
 String value)

The integration type of an integration.

One of the following:.

getConnectionId

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

The ID of the VPC link for a private integration.

setConnectionId

@Stability(Stable)
public void setConnectionId(@Nullable
 String value)

The ID of the VPC link for a private integration.

getConnectionType

@Stability(Stable)
@Nullable
public String getConnectionType()

The type of the network connection to the integration endpoint.

setConnectionType

@Stability(Stable)
public void setConnectionType(@Nullable
 String value)

The type of the network connection to the integration endpoint.

getContentHandlingStrategy

@Stability(Stable)
@Nullable
public String getContentHandlingStrategy()

Supported only for WebSocket APIs.

setContentHandlingStrategy

@Stability(Stable)
public void setContentHandlingStrategy(@Nullable
 String value)

Supported only for WebSocket APIs.

getCredentialsArn

@Stability(Stable)
@Nullable
public String getCredentialsArn()

Specifies the credentials required for the integration, if any.

setCredentialsArn

@Stability(Stable)
public void setCredentialsArn(@Nullable
 String value)

Specifies the credentials required for the integration, if any.

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.

setIntegrationSubtype

@Stability(Stable)
public void setIntegrationSubtype(@Nullable
 String value)

Supported only for HTTP API AWS_PROXY integrations.

getIntegrationUri

@Stability(Stable)
@Nullable
public String getIntegrationUri()

For a Lambda integration, specify the URI of a Lambda function.

setIntegrationUri

@Stability(Stable)
public void setIntegrationUri(@Nullable
 String value)

For a Lambda integration, specify the URI of a Lambda function.

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.

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.

getPayloadFormatVersion

@Stability(Stable)
@Nullable
public String getPayloadFormatVersion()

Specifies the format of the payload sent to an integration.

setPayloadFormatVersion

@Stability(Stable)
public void setPayloadFormatVersion(@Nullable
 String value)

Specifies the format of the payload sent to an integration.

getRequestParameters

@Stability(Stable)
@Nullable
public Object getRequestParameters()

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

setRequestParameters

@Stability(Stable)
public void setRequestParameters(@Nullable
 Object value)

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.

getRequestTemplates

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

setRequestTemplates

@Stability(Stable)
public void setRequestTemplates(@Nullable
 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.

getResponseParameters

@Stability(Stable)
@Nullable
public Object getResponseParameters()

Supported only for HTTP APIs.

setResponseParameters

@Stability(Stable)
public void setResponseParameters(@Nullable
 Object value)

Supported only for HTTP APIs.

getTemplateSelectionExpression

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

The template selection expression for the integration.

setTemplateSelectionExpression

@Stability(Stable)
public void setTemplateSelectionExpression(@Nullable
 String value)

The template selection expression for the integration.

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.

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.

getTlsConfig

@Stability(Stable)
@Nullable
public Object getTlsConfig()

The TLS configuration for a private integration.

Returns union: either IResolvable or CfnIntegration.TlsConfigProperty

setTlsConfig

@Stability(Stable)
public void setTlsConfig(@Nullable
 IResolvable value)

The TLS configuration for a private integration.

setTlsConfig

@Stability(Stable)
public void setTlsConfig(@Nullable
 CfnIntegration.TlsConfigProperty value)

The TLS configuration for a private integration.