AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGatewayV2::Stage

CfnStage

The `AWS::ApiGatewayV2::Stage` resource specifies a stage for an API. Each stage is a named reference to a deployment of the API and is made available for client applications to call. To learn more, see [Working with stages for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html) and [Deploy a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.html) .

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnStageProps.

apiIdRequired
string

The API identifier.

stageNameRequired
string

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be `$default` . Maximum length is 128 characters.

accessLogSettingsOptional
IResolvable | AccessLogSettingsProperty

Settings for logging access in this stage.

accessPolicyIdOptional
string

This parameter is not currently supported.

autoDeployOptional
boolean | IResolvable

Specifies whether updates to an API automatically trigger a new deployment. The default value is `false` .

clientCertificateIdOptional
string

The identifier of a client certificate for a `Stage` . Supported only for WebSocket APIs.

defaultRouteSettingsOptional
IResolvable | RouteSettingsProperty

The default route settings for the stage.

deploymentIdOptional
string

The deployment identifier for the API stage. Can't be updated if `autoDeploy` is enabled.

descriptionOptional
string

The description for the API stage.

routeSettingsOptional
any

Route settings for the stage.

stageVariablesOptional
any

A map that defines the stage variables for a `Stage` . Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

tagsOptional
any

The collection of tags. Each tag element is associated with a given resource.

CloudFormation Resource

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

AWS::ApiGatewayV2::StageView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-apigatewayv2
CFN TypeAWS::ApiGatewayV2::Stage
Properties12

Related Constructs

Explore This Service

External Links