Transit Gateways
List Transit Gateways
Returns a paginated collection of transit gateways for a given network.
Query Parameters
Filters supported for transit gateways.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Response
application/json
Response
A paginated list for a collection of transit gateways for a network.
ListTransitGatewaysResponse
returns the pagination information
Show Child Parameters
One OfShow Child Parameters
Authentication
Path Parameters
Query Parameters
Create Transit Gateway
Creates a new transit gateway for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
Body
application/json
Body
CreateTransitGatewayRequest
Request schema for creating a transit gateway.
One OfHuman-readable name of the transit gateway.
Example:us-east-2 transit gateway
List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.
Show Child Parameters
CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning
network.
Example:["10.0.0.0/8","100.64.0.0/10","172.16.0.0/12"]
Show Child Parameters
Response
application/json
Response
Response format for creating a transit gateway.
TransitGatewayResponse
One OfHuman-readable name of the transit gateway.
Example:us-east-2 transit gateway
List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.
Show Child Parameters
CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning
network.
Example:["10.0.0.0/8","100.64.0.0/10","172.16.0.0/12"]
Show Child Parameters
Example:0850820b-d153-4a2a-b9be-7d2204779139
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-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
Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.
Example:1
An RFC-3339 timestamp representation of transit gateway creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of transit gateway update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get Transit Gateway
Retrieves a transit gateway by ID for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
The ID of the transit gateway to operate on.
Example:0850820b-d153-4a2a-b9be-7d2204779139
Response
application/json
Response
Response format for retrieving a transit gateway.
TransitGatewayResponse
One OfHuman-readable name of the transit gateway.
Example:us-east-2 transit gateway
List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.
Show Child Parameters
CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning
network.
Example:["10.0.0.0/8","100.64.0.0/10","172.16.0.0/12"]
Show Child Parameters
Example:0850820b-d153-4a2a-b9be-7d2204779139
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-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
Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.
Example:1
An RFC-3339 timestamp representation of transit gateway creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of transit gateway update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update Transit Gateway
Updates a transit gateway by ID for a given network.
Path Parameters
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695
The ID of the transit gateway to operate on.
Example:0850820b-d153-4a2a-b9be-7d2204779139
Body
application/json
Body
PatchTransitGatewayRequest
Request schema for updating a transit gateway.
One OfShow Child Parameters
Response
application/json
Response
Response format for updating a transit gateway.
One OfHuman-readable name of the transit gateway.
Example:us-east-2 transit gateway
List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway
attachment.
Show Child Parameters
Show Child Parameters
Example:0850820b-d153-4a2a-b9be-7d2204779139
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-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
Metadata describing the backing state of the transit gateway and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the transit gateway, to indicate the order of updates to the
transit gateway.
Example:1
An RFC-3339 timestamp representation of transit gateway creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of transit gateway update date.
Example:2022-11-04T20:10:06.927Z