awsapigatewayv2_HttpStageOptions.go

package awsapigatewayv2


// The options to create a new Stage for an HTTP API.
//
// Example:
//   var api httpApi
//   var dn domainName
//
//
//   api.addStage(jsii.String("beta"), &httpStageOptions{
//   	stageName: jsii.String("beta"),
//   	autoDeploy: jsii.Boolean(true),
//   	// https://${dn.domainName}/bar goes to the beta stage
//   	domainMapping: &domainMappingOptions{
//   		domainName: dn,
//   		mappingKey: jsii.String("bar"),
//   	},
//   })
//
// Experimental.
type HttpStageOptions struct {
	// Whether updates to an API automatically trigger a new deployment.
	// Experimental.
	AutoDeploy *bool `field:"optional" json:"autoDeploy" yaml:"autoDeploy"`
	// The options for custom domain and api mapping.
	// Experimental.
	DomainMapping *DomainMappingOptions `field:"optional" json:"domainMapping" yaml:"domainMapping"`
	// Throttle settings for the routes of this stage.
	// Experimental.
	Throttle *ThrottleSettings `field:"optional" json:"throttle" yaml:"throttle"`
	// The name of the stage.
	//
	// See `StageName` class for more details.
	// Experimental.
	StageName *string `field:"optional" json:"stageName" yaml:"stageName"`
}