NetworkAvailabilityZones

array

List of availability zones that the network is attached to.

Example

Network

object

Object containing information about a network to be used in configurations.

idstring(uuid)required

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

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

namestringrequired

Human-readable name of the network.

Example:us-east-2 network

defaultbooleanrequired

Whether the network is a default network or not. Default networks are Networks that are created
automatically by Konnect when an organization is linked to a provider account.

cloud_gateway_provider_account_idstring(uuid)required

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

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:use2-az1, use2-az2, use2-az3

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

staterequiredread-only

State of the network.

Allowed values:createdinitializingofflinereadyterminatingterminated

state_metadataobjectread-only

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

* Additional properties are NOT allowed.
Show Child Parameters
provider_metadataobjectrequiredread-only

Metadata describing attributes returned by cloud-provider for the network.

* Additional properties are NOT allowed.
Show Child Parameters
transit_gateway_countintegerrequiredread-only

The number of transit gateways attached to this network.

configuration_reference_countintegerrequiredread-only

The number of configurations that reference this network.

entity_versionintegerrequiredread-only

Monotonically-increasing version count of the network, to indicate the order of updates to the network.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of network update date.

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

Example

CreateNetworkRequest

object

Request schema for creating a network.

* Additional properties are NOT allowed.
namestringrequired

Human-readable name of the network.

Example:us-east-2 network

cloud_gateway_provider_account_idstring(uuid)required

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

regionstringrequired

Region ID for cloud provider region.

Example:us-east-2

availability_zonesarray[string]required

List of availability zones that the network is attached to.

Example:use2-az1, use2-az2, use2-az3

cidr_blockstringrequired

CIDR block configuration for the network.

Example:10.0.0.0/8

statestring

Initial state for creating a network.

Allowed values:initializingoffline

Default:initializing

Example

PatchNetworkRequest

object

Request schema for updating a network.

* Additional properties are NOT allowed.
namestring

Human-readable name of the network.

Example:us-east-2 network

Example

Transit Gateway State

string

The current state of the Transit Gateway. Possible values:

  • created - The attachment has been created but is not attached to transit gateway.
  • initializing - The attachment is in the process of being initialized and is setting up necessary resources.
  • pending-acceptance The attachment request is awaiting acceptance in customer VPC.
  • pending-user-action The attachment request is awaiting user action in customer VPC.
  • ready - The transit gateway attachment is fully operational and can route traffic as configured.
  • terminating - The attachment is in the process of being deleted and is no longer accepting new traffic.
  • terminated - The attachment has been fully deleted and is no longer available.
  • error - The attachment is in an error state.

Allowed values:createdinitializingpending-acceptancepending-user-actionreadyterminatingterminatederror