# HttpStageOptions

The options to create a new Stage for an HTTP API.

Extends: HttpStageOptions
Extends: StageOptions

- Source: [`aws-apigatewayv2/lib/http/stage.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/http/stage.ts#L95)
- Type last changed: v2.112.0 · 1 Dec 2023

## Example

```ts
declare const api: apigwv2.HttpApi;
declare const dn: apigwv2.DomainName;

api.addStage('beta', {
  stageName: 'beta',
  autoDeploy: true,
  // https://${dn.domainName}/bar goes to the beta stage
  domainMapping: {
    domainName: dn,
    mappingKey: 'bar',
  },
});
```

## Properties

- `accessLogSettings`: [IAccessLogSettings](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IAccessLogSettings.html) — Settings for access logging.

  **Default:** No access logging

- `autoDeploy`: boolean = false — Whether updates to an API automatically trigger a new deployment.

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

  **Default:** no description

- `detailedMetricsEnabled`: boolean = false — Specifies whether detailed metrics are enabled.

- `domainMapping`: [DomainMappingOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.DomainMappingOptions.html) — The options for custom domain and api mapping.

  **Default:** no custom domain and api mapping configuration

- `stageName`: string — The name of the stage.

  **Default:** '$default' the default stage of the API. This stage will have the URL at the root of the API endpoint.

  See `StageName` class for more details.

- `stageVariables`: { [key: string]: string } — Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

  **Default:** No stage variables

  The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

- `throttle`: [ThrottleSettings](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.ThrottleSettings.html) — Throttle settings for the routes of this stage.

  **Default:** no throttling configuration