18min

Transit Gateway

Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.

Overview

You can currently query the following attributes and connections on an AWS Transit Gateway

GraphQL
|

Filtering

Get data for a single AWS Transit Gateway that you know the ID or arn for:

GraphQL
|
GraphQL
|

Get data for all of the Transit Gateways in a certain AWS account:

GraphQL
|

Get data for all of the Transit Gateways that are NOT in a certain AWS account:

GraphQL
|

Advanced Filtering

Get data for all of the Transit Gateways that have a connected transitGatewayAttachment:

GraphQL
|

Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the Transit Gateways that have transitGatewayAttachment instances AND vpnConnection instances connected to them OR that do not have routeTable instances connected to them. Note that you can use has, and, not, or completely independently of each other:

GraphQL
|

You may also filter using a regex when filtering on a string field like, region if you want to look for a value that matches say, us- to get all Transit Gateways in us regions:

GraphQL
|

Ordering

You can order the results you get back either asc or desc depending on your preference:

GraphQL
|

Only select and return the first two Transit Gateways that are found:

GraphQL
|

Only select and return the first two Transit Gateways that are found, but offset by one so Transit Gateways two & three are returned:

GraphQL
|

Aggregation

Count the number Transit Gateways across all scanned AWS accounts:

GraphQL
|

Count the number of Transit Gateways in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:

GraphQL
|

Examples

Find all of the Transit Gateways that are in the us-east-1 region across all your accounts:

GraphQL
|

Kitchen Sink

Putting it all together; get all data for all Transit Gateways across all regions for all scanned AWS accounts in a single query. For the purposes of this example we will only get direct children of the transit gateways but if you want to it's easy to go from say, transitGateway -> transitGatewayAttachment -> routeTable ...etc:

GraphQL
|

References