Skip to content

Describe Customer Gateways

ec2_describe_customer_gateways R Documentation

Describes one or more of your VPN customer gateways

Description

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Usage

ec2_describe_customer_gateways(CustomerGatewayIds, Filters, DryRun)

Arguments

CustomerGatewayIds

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Filters

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway device's external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:\<key\> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax: 

list(
  CustomerGateways = list(
    list(
      BgpAsn = "string",
      CustomerGatewayId = "string",
      IpAddress = "string",
      CertificateArn = "string",
      State = "string",
      Type = "string",
      DeviceName = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      BgpAsnExtended = "string"
    )
  )
)

Request syntax

svc$describe_customer_gateways(
  CustomerGatewayIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)

Examples

## Not run: 
# This example describes the specified customer gateway.
svc$describe_customer_gateways(
  CustomerGatewayIds = list(
    "cgw-0e11f167"
  )
)

## End(Not run)