@aws-cdk_aws-apigatewayv2-alpha.StageOptions

interface StageOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.StageOptions
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#StageOptions
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.StageOptions
Pythonaws_cdk.aws_apigatewayv2_alpha.StageOptions
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป StageOptions

Options required to create a new stage.

Options that are common between HTTP and Websocket APIs.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';

declare const domainName: apigatewayv2_alpha.DomainName;
const stageOptions: apigatewayv2_alpha.StageOptions = {
  autoDeploy: false,
  domainMapping: {
    domainName: domainName,

    // the properties below are optional
    mappingKey: 'mappingKey',
  },
  throttle: {
    burstLimit: 123,
    rateLimit: 123,
  },
};

Properties

NameTypeDescription
autoDeploy?๐Ÿ”นbooleanWhether updates to an API automatically trigger a new deployment.
domainMapping?๐Ÿ”นDomainMappingOptionsThe options for custom domain and api mapping.
throttle?๐Ÿ”นThrottleSettingsThrottle settings for the routes of this stage.

autoDeploy?๐Ÿ”น

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.


domainMapping?๐Ÿ”น

Type: DomainMappingOptions (optional, default: no custom domain and api mapping configuration)

The options for custom domain and api mapping.


throttle?๐Ÿ”น

Type: ThrottleSettings (optional, default: no throttling configuration)

Throttle settings for the routes of this stage.