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.
You can currently query the following attributes and connections on an AWS VPN Connection
query {
queryawsVpnConnection {
id
accountId
arn
region
category
customerGatewayId
state
type
vpnGatewayId
transitGatewayId
options {
id
enableAcceleration
staticRoutesOnly
localIpv4NetworkCidr
remoteIpv4NetworkCidr
tunnelInsideIpVersion
type
tunnelOptions {
id
outsideIpAddress
tunnelInsideCidr
preSharedKey
}
}
routes {
id
destinationCidrBlock
source
state
}
vgwTelemetry {
id
acceptedRouteCount
lastStatusChange
certificateArn
outsideIpAddress
status
statusMessage
}
tags {
id
key
value
}
transitGateway {
arn
}
customerGateway {
arn
}
vpnGateway {
arn
}
transitGatewayAttachment {
arn
}
}
}
Get data for a single AWS VPN Connection that you know the ID or arn for:
query {
getawsVpnConnection(id: "12345") {
arn
}
}
query {
getawsVpnConnection(arn: "arn:aws:ec2:us-east-1:111122223333:vpn-connection/vpn-11122223333f466ec") {
arn
}
}
Get data for all of the VPN Connections in a certain AWS account:
query {
queryawsVpnConnection(filter: { accountId: { eq: "12345" } }) {
arn
}
}
Get data for all of the VPN Connections that are NOT in a certain AWS account:
query {
queryawsVpnConnection(filter: { not: { accountId: { eq: "12345" } } }) {
arn
}
}
Get data for all of the VPN Connections that have a connected transitGateway:
query {
queryawsVpnConnection(filter: { has: transitGateway }) {
arn
}
}
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the VPN Connections that have DNS Support AND transitGatewayAttachment instances connected to them OR that do not have route tables connected to them. Note that you can use has, and, not, or completely independently of each other:
query {
queryawsTransitGateway(
filter: {
has: dnsSupport
and: { has: transitGatewayAttachment }
or: { not: { has: routeTable } }
}
) {
arn
}
}
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 VPN Connections in us regions:
query {
queryawsVpnConnection(filter: { region: { regexp: "/.*us-*/" } }) {
arn
}
}
You can order the results you get back either asc or desc depending on your preference:
query {
queryawsVpnConnection(order: { desc: region }) {
arn
}
}
Only select and return the first two VPN Connections that are found:
query {
queryawsVpnConnection(first: 2, order: { desc: region }) {
arn
}
}
Only select and return the first two VPN Connections that are found, but offset by one so VPN Connections two & three are returned:
query {
queryawsVpnConnection(first: 2, order: { desc: region }, offset: 1) {
arn
}
}
Count the number VPN Connections across all scanned AWS accounts:
query {
aggregateawsVpnConnection {
count
}
}
Count the number of VPN Connections in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
query {
aggregateawsVpnConnection(filter: { accountId: { eq: "12345" } }) {
count
}
}
Find all of the VPN Connections that are in the us-east-1 region across all your accounts:
query {
queryawsVpnConnection(filter: { region: { eq: "us-east-1" } }) {
arn
}
}
Putting it all together; get all data for all VPN Connections 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 vpn connections but if you want to it's easy to go from say, vpnConnection -> transitGateway -> transitGatewayAttachment ...etc:
query {
queryawsVpnConnection {
id
accountId
arn
region
category
customerGatewayId
state
type
vpnGatewayId
transitGatewayId
options {
id
enableAcceleration
staticRoutesOnly
localIpv4NetworkCidr
remoteIpv4NetworkCidr
tunnelInsideIpVersion
type
tunnelOptions {
id
outsideIpAddress
tunnelInsideCidr
preSharedKey
}
}
routes {
id
destinationCidrBlock
source
state
}
vgwTelemetry {
id
acceptedRouteCount
lastStatusChange
certificateArn
outsideIpAddress
status
statusMessage
}
tags {
id
key
value
}
transitGateway {
id
accountId
arn
region
ownerId
description
dnsSupport
vpnEcmpSupport
amazonSideAsn
autoAcceptSharedAttachments
defaultRouteTableAssociation
associationDefaultRouteTableId
defaultRouteTableAssociation
propagationDefaultRouteTableId
tags {
id
key
value
}
routeTable {
arn
}
transitGatewayAttachment {
arn
}
vpnConnection {
arn
}
}
customerGateway {
id
accountId
arn
region
type
bgpAsn
tags {
id
key
value
}
vpnConnection {
arn
}
}
vpnGateway {
id
accountId
arn
region
type
state
amazonSideAsn
vpcIds
tags {
id
key
value
}
vpc {
arn
}
vpnConnection {
arn
}
}
transitGatewayAttachment {
id
accountId
arn
region
transitGatewayId
transitGatewayOwnerId
resourceOwnerId
resourceType
resourceId
state
transitGatewayRouteTableId
creationTime
tags {
id
key
value
}
routeTable {
arn
}
transitGateway {
arn
}
vpc {
arn
}
vpnConnection {
arn
}
}
}
}
