AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGatewayV2::Deployment

ApiGatewayV2 Deployment

The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.

Properties

3 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
Description
string
StageName
string
Write-only

Return Values

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

AttributeTypeDescription
DeploymentIdstring-

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

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

Required IAM Permissions

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

create

apigateway:POST

update

apigateway:PATCHapigateway:GETapigateway:PUT

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
Properties4
Required1
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