aws-cdk-lib.aws_apigatewayv2.CfnStageProps

interface CfnStageProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnStageProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnStageProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnStageProps
Pythonaws_cdk.aws_apigatewayv2.CfnStageProps
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnStageProps

Properties for defining a CfnStage.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const routeSettings: any;
declare const stageVariables: any;
declare const tags: any;
const cfnStageProps: apigatewayv2.CfnStageProps = {
  apiId: 'apiId',
  stageName: 'stageName',

  // the properties below are optional
  accessLogSettings: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  accessPolicyId: 'accessPolicyId',
  autoDeploy: false,
  clientCertificateId: 'clientCertificateId',
  defaultRouteSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  deploymentId: 'deploymentId',
  description: 'description',
  routeSettings: routeSettings,
  stageVariables: stageVariables,
  tags: tags,
};

Properties

NameTypeDescription
apiIdstringThe API identifier.
stageNamestringThe stage name.
accessLogSettings?IResolvable | AccessLogSettingsPropertySettings for logging access in this stage.
accessPolicyId?stringThis parameter is not currently supported.
autoDeploy?boolean | IResolvableSpecifies whether updates to an API automatically trigger a new deployment.
clientCertificateId?stringThe identifier of a client certificate for a Stage .
defaultRouteSettings?IResolvable | RouteSettingsPropertyThe default route settings for the stage.
deploymentId?stringThe deployment identifier for the API stage.
description?stringThe description for the API stage.
routeSettings?anyRoute settings for the stage.
stageVariables?anyA map that defines the stage variables for a Stage .
tags?anyThe collection of tags.

apiId

Type: string

The API identifier.


stageName

Type: string

The stage name.

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


accessLogSettings?

Type: IResolvable | AccessLogSettingsProperty (optional)

Settings for logging access in this stage.


accessPolicyId?

Type: string (optional)

This parameter is not currently supported.


autoDeploy?

Type: boolean | IResolvable (optional)

Specifies whether updates to an API automatically trigger a new deployment.

The default value is false .


clientCertificateId?

Type: string (optional)

The identifier of a client certificate for a Stage .

Supported only for WebSocket APIs.


defaultRouteSettings?

Type: IResolvable | RouteSettingsProperty (optional)

The default route settings for the stage.


deploymentId?

Type: string (optional)

The deployment identifier for the API stage.

Can't be updated if autoDeploy is enabled.


description?

Type: string (optional)

The description for the API stage.


routeSettings?

Type: any (optional)

Route settings for the stage.


stageVariables?

Type: any (optional)

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-._~:/?#&=,]+.


tags?

Type: any (optional)

The collection of tags.

Each tag element is associated with a given resource.