CreateConfigurationDataPlaneGroup

object

Object that describes where to deploy a data-plane group, along with how many instances.

* Additional properties are NOT allowed.
providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

cloud_gateway_network_idstring(uuid)

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

autoscaleOne Of
Configuration Autoscale StaticobjectDEPRECATED

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.
Show Child Parameters
environmentarray[object]

Environment variable name and value to set for a data-plane group.

Show Child Parameters
Example

Cloud Gateway Provider Account

object

Object containing mapping for organization and cloud provider to account ID.

idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

provider_account_idstringrequiredread-only

ID of the cloud provider account.

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of provider account creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of provider account update date.

Example:2022-11-04T20:10:06.927Z

Example

Network Create State

string

Initial state for creating a network.

Allowed values:initializingoffline

Default:initializing

Network State

State of the network.

Allowed values:createdinitializingofflinereadyterminatingterminated

Network State Metadata

object

Metadata describing the backing state of the network and why it may be in an erroneous state.

* Additional properties are NOT allowed.
reported_statusstring

Reported status of the network from backing infrastructure.

Example:INVALID

reasonstring

Reason why the network may be in an erroneous state, reported from backing infrastructure.

Example:Network could not be deployed due to insufficient cloud provider compute instances.

Example