AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::Integration

ApiGatewayV2 Integration

Resource Type definition for AWS::ApiGatewayV2::Integration

Properties

18 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
IntegrationType
string
Required
ConnectionId
string
ConnectionType
string
ContentHandlingStrategy
string
CredentialsArn
string
Description
string
IntegrationMethod
string
IntegrationSubtype
string
IntegrationUri
string
PassthroughBehavior
string
PayloadFormatVersion
string
RequestParameters
object
RequestTemplates
object
ResponseParameters
object
TemplateSelectionExpression
string
TimeoutInMillis
integer
TlsConfig
TlsConfig

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
IntegrationIdstringThe integration ID.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGatewayV2::Integration

Resources:
  MyResource:
    Type: AWS::ApiGatewayV2::Integration
    Properties:
      ApiId: "my-apiid"
      IntegrationType: "value"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:POSTiam:PassRole

update

apigateway:PATCHapigateway:GETapigateway:PUTiam:PassRole

read

apigateway:GET

delete

apigateway:GETapigateway:DELETE

list

apigateway:GET

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceApiGatewayV2
Properties19
Required2
TaggingNot supported
Primary IDApiId

Supported Operations

CreateUpdateReadDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ApiId

Related Resources

External Links