Serverless V1 Providers

array

List of supported cloud providers that run serverless v1 cloud gateway instances.

providerstringrequired

Name of cloud provider.

Allowed values:aws

Example:aws

regionsarray[object]required

Region ID and human-readable name for a cloud provider region.

* Additional properties are NOT allowed.
Show Child Parameters

Availability Document

object

Document containing availability information for configurations.

* Additional properties are NOT allowed.
versionsarray[string]requiredread-only

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

instance_typesarray[object]requiredread-only

Resource parameters and pricing of a given supported instance type.

* Additional properties are NOT allowed.
Show Child Parameters
providersarray[object]required

Description of cloud provider that runs cloud gateway instances.

* Additional properties are NOT allowed.
Show Child Parameters
serverless_v1_providersarray[object]required

Description of cloud provider that runs serverless v1 cloud gateway instances.

* Additional properties are NOT allowed.
Show Child Parameters
Example

ConfigurationDataPlaneGroupAutoscale

One Of
kindstringrequired

Allowed values:static

instance_typestringrequired

Instance type name to indicate capacity.

Allowed values:smallmediumlarge

requested_instancesintegerrequired

Number of data-planes the deployment target will contain.

Example:3

Example

Configuration Autoscale Static

object

Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a future version. For serverless.v1 kind of cloud gateways, this field should be omitted.

* Additional properties are NOT allowed.
kindstringrequired

Allowed values:static

instance_typestringrequired

Instance type name to indicate capacity.

Allowed values:smallmediumlarge

requested_instancesintegerrequired

Number of data-planes the deployment target will contain.

Example:3

Example

Configuration Autoscale Autopilot

object

Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.

* Additional properties are NOT allowed.
kindstringrequired

Allowed values:autopilot

base_rpsintegerrequired

Base number of requests per second that the deployment target should support.

Example:1

max_rpsintegerDEPRECATED

Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps. This field is deprecated and shouldn’t be used in new configurations as it will be removed in a future version. max_rps is now calculated as 10x base_rps.

Example:1000

Example