VPN Gateway

17min
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.
OverviewYou can currently query the following attributes and connections on an AWS VPN Gateway
GraphQL
|
query{
  queryawsVpnGateway {
    id
    accountId
    arn
    region
    type
    state
    amazonSideAsn
    vpcIds
    tags {
      id
      key
      value
    }
    vpc {
      arn
      # Other fields and connections here...
    }
    vpnConnection {
      arn
      # Other fields and connections here...
    }
  }
}
query{
  queryawsVpnGateway {
    id
    accountId
    arn
    region
    type
    state
    amazonSideAsn
    vpcIds
    tags {
      id
      key
      value
    }
    vpc {
      arn
      # Other fields and connections here...
    }
    vpnConnection {
      arn
      # Other fields and connections here...
    }
  }
}
﻿
FilteringGet data for a single AWS VPN Gateway that you know the ID or arn for:
GraphQL
|
query {
  getawsVpnGateway(id: "12345") {
    arn
    # Other fields and connections here...
  }
}
query {
  getawsVpnGateway(id: "12345") {
    arn
    # Other fields and connections here...
  }
}
﻿
GraphQL
|
query {
  getawsVpnGateway(arn: "arn:aws:ec2:us-east-1:111122223333:vpn-gateway/vpn-gtw-11122223333f466ec") {
    arn
    # Other fields and connections here...
  }
}
query {
  getawsVpnGateway(arn: "arn:aws:ec2:us-east-1:111122223333:vpn-gateway/vpn-gtw-11122223333f466ec") {
    arn
    # Other fields and connections here...
  }
}
﻿
Get data for all of the VPN Gateways in a certain AWS account:
GraphQL
|
query {
  queryawsVpnGateway(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "accountId" you can
# Filter based on any of the following attributes:

# id
# arn
# region
# type
# state
# amazonSideAsn
# vpcIds

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)
query {
  queryawsVpnGateway(filter: { accountId: { eq: "12345" } }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "accountId" you can
# Filter based on any of the following attributes:

# id
# arn
# region
# type
# state
# amazonSideAsn
# vpcIds

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)
﻿
Get data for all of the VPN Gateways that are NOT in a certain AWS account:
GraphQL
|
query {
  queryawsVpnGateway(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsVpnGateway(filter: { not: { accountId: { eq: "12345" } } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Advanced FilteringGet data for all of the VPN Gateways that have a connected vpc:
GraphQL
|
query {
  queryawsVpnGateway(filter: { has: vpc }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "vpc" you can filter
# Using "has" based on any of the following attributes:

# id
# accountId
# arn
# region
# type
# state
# amazonSideAsn
# vpcIds
# tags
# vpnConnection
query {
  queryawsVpnGateway(filter: { has: vpc }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "vpc" you can filter
# Using "has" based on any of the following attributes:

# id
# accountId
# arn
# region
# type
# state
# amazonSideAsn
# vpcIds
# tags
# vpnConnection
﻿
Use multiple filter selectors, (i.e. has, and, not, or) to get data for all of the VPN Gateways that have a VPC  AND  transitGatewayAttachment connected to them OR that do not have tags. Note that you can use has, and, not, or completely independently of each other:
GraphQL
|
query {
  queryawsTransitGateway(
    filter: {
      has: vpnConnection
      and: { has: transitGatewayAttachment }
      or: { not: { has: tags } }
    }
  ) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsTransitGateway(
    filter: {
      has: vpnConnection
      and: { has: transitGatewayAttachment }
      or: { not: { has: tags } }
    }
  ) {
    arn
    # Other fields and connections here...
  }
}
﻿
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 Gateways in us regions:
GraphQL
|
query {
  queryawsVpnGateway(filter: { region: { regexp: "/.*us-*/" } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsVpnGateway(filter: { region: { regexp: "/.*us-*/" } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
OrderingYou can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query {
  queryawsVpnGateway(order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "region" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# accountId
# arn
# type
# state
# amazonSideAsn
# vpcIds
query {
  queryawsVpnGateway(order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}

# Note that in addition to "region" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# accountId
# arn
# type
# state
# amazonSideAsn
# vpcIds
﻿
Only select and return the first two VPN Gateway that are found:
GraphQL
|
query {
  queryawsVpnGateway(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsVpnGateway(first: 2, order: { desc: region }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two VPN Gateways that are found, but offset by one so VPN Gateways two & three are returned:
GraphQL
|
query {
  queryawsVpnGateway(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsVpnGateway(first: 2, order: { desc: region }, offset: 1) {
    arn
    # Other fields and connections here...
  }
}
﻿
AggregationCount the number VPN Gateways across all scanned AWS accounts:
GraphQL
|
query {
  aggregateawsVpnGateway {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your VPN Gateway:

# idMin
# idMax
# accountIdMin
# accountIdMax
# arnMin
# arnMax
# regionMin
# regionMax
# typeMin
# typeMax
# stateMin
# stateMax
# amazonSideAsnMin
# amazonSideAsnMax
query {
  aggregateawsVpnGateway {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your VPN Gateway:

# idMin
# idMax
# accountIdMin
# accountIdMax
# arnMin
# arnMax
# regionMin
# regionMax
# typeMin
# typeMax
# stateMin
# stateMax
# amazonSideAsnMin
# amazonSideAsnMax
﻿
Count the number of VPN Gateways in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query {
  aggregateawsVpnGateway(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateawsVpnGateway(filter: { accountId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
ExamplesFind all of the VPN Gateways that are in the us-east-1 region across all your accounts:
GraphQL
|
query {
  queryawsVpnGateway(filter: { region: { eq: "us-east-1" } }) {
    arn
    # Other fields and connections here...
  }
}
query {
  queryawsVpnGateway(filter: { region: { eq: "us-east-1" } }) {
    arn
    # Other fields and connections here...
  }
}
﻿
Kitchen SinkPutting it all together; get all data for all VPN 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 vpn gateways but if you want to it's easy to go from say, vpnGateway -> vpnConnection -> customerGateway ...etc:
GraphQL
|
query{
  queryawsVpnGateway {
    id
    accountId
    arn
    region
    type
    state
    amazonSideAsn
    vpcIds
    tags {
      id
      key
      value
    }
    vpc {
      accountId
      arn
      defaultVpc
      dhcpOptionsSet
      enableDnsHostnames
      enableDnsSupport
      id
      instanceTenancy
      ipV4Cidr
      ipV6Cidr
      state
      alb {
        arn
        # Other fields and connections here...
      }
      eip {
        arn
        # Other fields and connections here...
      }
      elb {
        arn
        # Other fields and connections here...
      }
      igw {
        arn
        # Other fields and connections here...
      }
      tags {
        id
        key
        value
      }
      nacl {
        arn
        # Other fields and connections here...
      }
      lambda {
        arn
        # Other fields and connections here...
      }
      subnet {
        arn
        # Other fields and connections here...
      }
      natGateway {
        arn
        # Other fields and connections here...
      }
      routeTable {
        arn
        # Other fields and connections here...
      }
      rdsDbInstance {
        # Other fields and connections here...
        arn
      }
      route53HostedZone {
        # Other fields and connections here...
        arn
      }
    }
    vpnConnection {
      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
        # Other fields and connections here...
      }
      customerGateway {
        arn
        # Other fields and connections here...
      }
      vpnGateway {
        arn
        # Other fields and connections here...
      }
      transitGatewayAttachment {
        arn
        # Other fields and connections here...
      }
    }
  }
}
query{
  queryawsVpnGateway {
    id
    accountId
    arn
    region
    type
    state
    amazonSideAsn
    vpcIds
    tags {
      id
      key
      value
    }
    vpc {
      accountId
      arn
      defaultVpc
      dhcpOptionsSet
      enableDnsHostnames
      enableDnsSupport
      id
      instanceTenancy
      ipV4Cidr
      ipV6Cidr
      state
      alb {
        arn
        # Other fields and connections here...
      }
      eip {
        arn
        # Other fields and connections here...
      }
      elb {
        arn
        # Other fields and connections here...
      }
      igw {
        arn
        # Other fields and connections here...
      }
      tags {
        id
        key
        value
      }
      nacl {
        arn
        # Other fields and connections here...
      }
      lambda {
        arn
        # Other fields and connections here...
      }
      subnet {
        arn
        # Other fields and connections here...
      }
      natGateway {
        arn
        # Other fields and connections here...
      }
      routeTable {
        arn
        # Other fields and connections here...
      }
      rdsDbInstance {
        # Other fields and connections here...
        arn
      }
      route53HostedZone {
        # Other fields and connections here...
        arn
      }
    }
    vpnConnection {
      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
        # Other fields and connections here...
      }
      customerGateway {
        arn
        # Other fields and connections here...
      }
      vpnGateway {
        arn
        # Other fields and connections here...
      }
      transitGatewayAttachment {
        arn
        # Other fields and connections here...
      }
    }
  }
}
﻿
References﻿Dgraph documentation on querying﻿
﻿AWS VPN Gateway documentation﻿