L1 ConstructAWS::ApiGatewayV2::Deployment

CfnDeployment

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

Import

import { CfnDeployment } from 'aws-cdk-lib/aws-apigatewayv2';

Or use the module namespace:

import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.CfnDeployment

Configuration passed to the constructor as CfnDeploymentProps.

apiIdRequired

string | IApiRef

The API identifier.

descriptionOptional

string

The description for the deployment resource.

stageNameOptional

string

The name of an existing stage to associate with the deployment.

This L1 construct maps directly to the following CloudFormation resource type.

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

LevelL1 (CloudFormation)

Moduleaws-apigatewayv2

CFN TypeAWS::ApiGatewayV2::Deployment

Properties3