Class CfnIntegrationProps
Properties for defining a CfnIntegration.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIntegrationProps : ICfnIntegrationPropsSyntax (vb)
Public Class CfnIntegrationProps Implements ICfnIntegrationPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
var requestParameters;
var requestTemplates;
var responseParameters;
var cfnIntegrationProps = new CfnIntegrationProps {
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 = new TlsConfigProperty {
ServerNameToVerify = "serverNameToVerify"
}
};Synopsis
Constructors
| CfnIntegrationProps() | Properties for defining a |
Properties
| ApiId | The API identifier. |
| ConnectionId | The ID of the VPC link for a private integration. |
| ConnectionType | The type of the network connection to the integration endpoint. |
| ContentHandlingStrategy | Supported only for WebSocket APIs. |
| CredentialsArn | Specifies the credentials required for the integration, if any. |
| Description | The description of the integration. |
| IntegrationMethod | Specifies the integration's HTTP method type. |
| IntegrationSubtype | Supported only for HTTP API |
| IntegrationType | The integration type of an integration. One of the following:. |
| IntegrationUri | For a Lambda integration, specify the URI of a Lambda function. |
| PassthroughBehavior | Specifies the pass-through behavior for incoming requests based on the |
| PayloadFormatVersion | Specifies the format of the payload sent to an integration. |
| RequestParameters | For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. |
| RequestTemplates | 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. |
| ResponseParameters | Supported only for HTTP APIs. |
| TemplateSelectionExpression | The template selection expression for the integration. |
| TimeoutInMillis | Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. |
| TlsConfig | The TLS configuration for a private integration. |
Constructors
CfnIntegrationProps()
Properties for defining a CfnIntegration.
public CfnIntegrationProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
var requestParameters;
var requestTemplates;
var responseParameters;
var cfnIntegrationProps = new CfnIntegrationProps {
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 = new TlsConfigProperty {
ServerNameToVerify = "serverNameToVerify"
}
};Properties
ApiId
The API identifier.
public string ApiId { get; set; }Property Value
Remarks
ConnectionId
The ID of the VPC link for a private integration.
public string? ConnectionId { get; set; }Property Value
Remarks
ConnectionType
The type of the network connection to the integration endpoint.
public string? ConnectionType { get; set; }Property Value
Remarks
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 .
ContentHandlingStrategy
Supported only for WebSocket APIs.
public string? ContentHandlingStrategy { get; set; }Property Value
Remarks
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.
CredentialsArn
Specifies the credentials required for the integration, if any.
public string? CredentialsArn { get; set; }Property Value
Remarks
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.
Description
The description of the integration.
public string? Description { get; set; }Property Value
Remarks
IntegrationMethod
Specifies the integration's HTTP method type.
public string? IntegrationMethod { get; set; }Property Value
Remarks
For WebSocket APIs, if you use a Lambda integration, you must set the integration method to POST .
IntegrationSubtype
Supported only for HTTP API AWS_PROXY integrations.
public string? IntegrationSubtype { get; set; }Property Value
Remarks
Specifies the AWS service action to invoke. To learn more, see Integration subtype reference .
IntegrationType
The integration type of an integration. One of the following:.
public string IntegrationType { get; set; }Property Value
Remarks
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.
IntegrationUri
For a Lambda integration, specify the URI of a Lambda function.
public string? IntegrationUri { get; set; }Property Value
Remarks
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 .
PassthroughBehavior
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.
public string? PassthroughBehavior { get; set; }Property Value
Remarks
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.
PayloadFormatVersion
Specifies the format of the payload sent to an integration.
public string? PayloadFormatVersion { get; set; }Property Value
Remarks
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 .
RequestParameters
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend.
public object? RequestParameters { get; set; }Property Value
Remarks
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 <action>:<header|querystring|path>.<location> 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 .
RequestTemplates
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.
public object? RequestTemplates { get; set; }Property Value
Remarks
The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
ResponseParameters
Supported only for HTTP APIs.
public object? ResponseParameters { get; set; }Property Value
Remarks
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 .
TemplateSelectionExpression
The template selection expression for the integration.
public string? TemplateSelectionExpression { get; set; }Property Value
Remarks
TimeoutInMillis
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs.
public double? TimeoutInMillis { get; set; }Property Value
Remarks
The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig
The TLS configuration for a private integration.
public object? TlsConfig { get; set; }Property Value
Remarks
If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.