Network
objectObject containing information about a network to be used in configurations.
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Human-readable name of the network.
Example:us-east-2 network
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.
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Region ID for cloud provider region.
Example:us-east-2
List of availability zones that the network is attached to.
Example:use2-az1, use2-az2, use2-az3
CIDR block configuration for the network.
Example:10.0.0.0/8
State of the network.
Allowed values:createdinitializingofflinereadyterminatingterminated
Metadata describing the backing state of the network and why it may be in an erroneous state.
Show Child Parameters
Metadata describing attributes returned by cloud-provider for the network.
Show Child Parameters
The number of transit gateways attached to this network.
The number of configurations that reference this network.
Monotonically-increasing version count of the network, to indicate the order of updates to the network.
Example:1
An RFC-3339 timestamp representation of network creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of network update date.
Example:2022-11-04T20:10:06.927Z
CreateNetworkRequest
objectRequest schema for creating a network.
Human-readable name of the network.
Example:us-east-2 network
Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae
Region ID for cloud provider region.
Example:us-east-2
List of availability zones that the network is attached to.
Example:use2-az1, use2-az2, use2-az3
CIDR block configuration for the network.
Example:10.0.0.0/8
Initial state for creating a network.
Allowed values:initializingoffline
Default:initializing
PatchNetworkRequest
objectRequest schema for updating a network.
Human-readable name of the network.
Example:us-east-2 network
Transit Gateway State
stringThe 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-acceptanceThe attachment request is awaiting acceptance in customer VPC.pending-user-actionThe 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
AWS Resource Endpoint Config State
stringThe current state of the resource config in AWS Resource Endpoint. Possible values:
initializing- The config is in the process of being initialized and is setting up necessary resources.missing- The config is missing and is no longer accepting new traffic.ready- The config is fully operational and can route traffic as configured.error- The config is in an error state, and is not operational.terminating- The config is in the process of being deleted and is no longer accepting new traffic.
Allowed values:initializingmissingreadyerrorterminating