# CfnStageProps

Properties for defining a `CfnStage`.

Extends: CfnStageProps
Used as props by: CfnStage

- Source: Generated code

## Example

```ts
// 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

- `accessLogSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStage.AccessLogSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.CfnStage.AccessLogSettingsProperty.html) — Settings for logging access in this stage.

- `accessPolicyId`: string — This parameter is not currently supported.

- `apiId`: string (required) — The API identifier.

- `autoDeploy`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Specifies whether updates to an API automatically trigger a new deployment.

  The default value is `false` .

- `clientCertificateId`: string — The identifier of a client certificate for a `Stage` .

  Supported only for WebSocket APIs.

- `defaultRouteSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnStage.RouteSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.CfnStage.RouteSettingsProperty.html) — The default route settings for the stage.

- `deploymentId`: string — The deployment identifier for the API stage.

  Can't be updated if `autoDeploy` is enabled.

- `description`: string — The description for the API stage.

- `routeSettings`: any — Route settings for the stage.

- `stageName`: string (required) — The stage name.

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

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

- `tags`: any — The collection of tags.

  Each tag element is associated with a given resource.