AWS API Gateway V2 Integration
This page shows how to write Terraform and CloudFormation for API Gateway V2 Integration and write them securely.
aws_apigatewayv2_integration (Terraform)
The Integration in API Gateway V2 can be configured in Terraform with the resource name aws_apigatewayv2_integration. The following sections describe 1 example of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_apigatewayv2_integration" "cars" {
api_id = aws_apigatewayv2_api.neocar_api.id
integration_type = "HTTP_PROXY"
integration_method = "ANY"
integration_uri = var.LBListener
connection_type = "VPC_LINK"
Parameters
-
api_idrequired - string -
connection_idoptional - string -
connection_typeoptional - string -
content_handling_strategyoptional - string -
credentials_arnoptional - string -
descriptionoptional - string -
idoptional computed - string -
integration_methodoptional - string -
integration_response_selection_expressionoptional computed - string -
integration_subtypeoptional - string -
integration_typerequired - string -
integration_urioptional - string -
passthrough_behavioroptional - string -
payload_format_versionoptional - string -
request_parametersoptional - map from string to string -
request_templatesoptional - map from string to string -
template_selection_expressionoptional - string -
timeout_millisecondsoptional computed - number -
response_parametersset block-
mappingsrequired - map from string to string -
status_coderequired - string
-
-
tls_configlist block-
server_name_to_verifyoptional - string
-
Explanation in Terraform Registry
Manages an Amazon API Gateway Version 2 integration. More information can be found in the Amazon API Gateway Developer Guide.
AWS::ApiGatewayV2::Integration (CloudFormation)
The Integration in ApiGatewayV2 can be configured in CloudFormation with the resource name AWS::ApiGatewayV2::Integration. The following sections describe 2 examples of how to use the resource and its parameters.
Example Usage from GitHub
"default" : "AWS::ApiGatewayV2::Integration"
},
"Properties" : {
"$ref" : "AWS_ApiGatewayV2_Integration.schema.json"
}
}
"default" : "AWS::ApiGatewayV2::IntegrationResponse"
},
"Properties" : {
"$ref" : "AWS_ApiGatewayV2_IntegrationResponse.schema.json"
}
}
Parameters
-
Descriptionoptional - String -
TemplateSelectionExpressionoptional - String -
ConnectionTypeoptional - String -
ResponseParametersoptional - Json -
IntegrationMethodoptional - String -
PassthroughBehavioroptional - String -
RequestParametersoptional - Json -
ConnectionIdoptional - String -
IntegrationUrioptional - String -
PayloadFormatVersionoptional - String -
CredentialsArnoptional - String -
RequestTemplatesoptional - Json -
TimeoutInMillisoptional - Integer -
TlsConfigoptional - TlsConfig -
ContentHandlingStrategyoptional - String -
IntegrationSubtypeoptional - String -
ApiIdrequired - String -
IntegrationTyperequired - String
Explanation in CloudFormation Registry
The
AWS::ApiGatewayV2::Integrationresource creates an integration for an API.
Frequently asked questions
What is AWS API Gateway V2 Integration?
AWS API Gateway V2 Integration is a resource for API Gateway V2 of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS API Gateway V2 Integration?
For Terraform, the CyberiumShadow/CloudComputing-Assignment3 source code example is useful. See the Terraform Example section for further details.
For CloudFormation, the shiver-me-timbers/smt-cloudformation-parent and shiver-me-timbers/smt-cloudformation-parent source code examples are useful. See the CloudFormation Example section for further details.
