---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_directconnect_virtual_interface{% #aws_directconnect_virtual_interface %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `address_family`{% #address_family %}

**Type**: `STRING`**Provider name**: `addressFamily`**Description**: The address family for the BGP peer.

## `amazon_address`{% #amazon_address %}

**Type**: `STRING`**Provider name**: `amazonAddress`**Description**: The IP address assigned to the Amazon interface.

## `amazon_side_asn`{% #amazon_side_asn %}

**Type**: `INT64`**Provider name**: `amazonSideAsn`**Description**: The autonomous system number (ASN) for the Amazon side of the connection.

## `asn`{% #asn %}

**Type**: `INT32`**Provider name**: `asn`**Description**: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. The valid values are 1-2147483647.

## `auth_key`{% #auth_key %}

**Type**: `STRING`**Provider name**: `authKey`**Description**: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

## `aws_device_v2`{% #aws_device_v2 %}

**Type**: `STRING`**Provider name**: `awsDeviceV2`**Description**: The Direct Connect endpoint that terminates the physical connection.

## `aws_logical_device_id`{% #aws_logical_device_id %}

**Type**: `STRING`**Provider name**: `awsLogicalDeviceId`**Description**: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

## `bgp_peers`{% #bgp_peers %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `bgpPeers`**Description**: The BGP peers configured on this virtual interface.

- `address_family`**Type**: `STRING`**Provider name**: `addressFamily`**Description**: The address family for the BGP peer.
- `amazon_address`**Type**: `STRING`**Provider name**: `amazonAddress`**Description**: The IP address assigned to the Amazon interface.
- `asn`**Type**: `INT32`**Provider name**: `asn`**Description**: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- `auth_key`**Type**: `STRING`**Provider name**: `authKey`**Description**: The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
- `aws_device_v2`**Type**: `STRING`**Provider name**: `awsDeviceV2`**Description**: The Direct Connect endpoint that terminates the BGP peer.
- `aws_logical_device_id`**Type**: `STRING`**Provider name**: `awsLogicalDeviceId`**Description**: The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
- `bgp_peer_id`**Type**: `STRING`**Provider name**: `bgpPeerId`**Description**: The ID of the BGP peer.
- `bgp_peer_state`**Type**: `STRING`**Provider name**: `bgpPeerState`**Description**: The state of the BGP peer. The following are the possible values:
  - `verifying`: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
  - `pending`: The BGP peer is created, and remains in this state until it is ready to be established.
  - `available`: The BGP peer is ready to be established.
  - `deleting`: The BGP peer is being deleted.
  - `deleted`: The BGP peer is deleted and cannot be established.
- `bgp_status`**Type**: `STRING`**Provider name**: `bgpStatus`**Description**: The status of the BGP peer. The following are the possible values:
  - `up`: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
  - `down`: The BGP peer is down.
  - `unknown`: The BGP peer status is not available.
- `customer_address`**Type**: `STRING`**Provider name**: `customerAddress`**Description**: The IP address assigned to the customer interface.

## `connection_id`{% #connection_id %}

**Type**: `STRING`**Provider name**: `connectionId`**Description**: The ID of the connection.

## `customer_address`{% #customer_address %}

**Type**: `STRING`**Provider name**: `customerAddress`**Description**: The IP address assigned to the customer interface.

## `customer_router_config`{% #customer_router_config %}

**Type**: `STRING`**Provider name**: `customerRouterConfig`**Description**: The customer router configuration.

## `direct_connect_gateway_id`{% #direct_connect_gateway_id %}

**Type**: `STRING`**Provider name**: `directConnectGatewayId`**Description**: The ID of the Direct Connect gateway.

## `jumbo_frame_capable`{% #jumbo_frame_capable %}

**Type**: `BOOLEAN`**Provider name**: `jumboFrameCapable`**Description**: Indicates whether jumbo frames are supported.

## `location`{% #location %}

**Type**: `STRING`**Provider name**: `location`**Description**: The location of the connection.

## `mtu`{% #mtu %}

**Type**: `INT32`**Provider name**: `mtu`**Description**: The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

## `owner_account`{% #owner_account %}

**Type**: `STRING`**Provider name**: `ownerAccount`**Description**: The ID of the Amazon Web Services account that owns the virtual interface.

## `region`{% #region %}

**Type**: `STRING`**Provider name**: `region`**Description**: The Amazon Web Services Region where the virtual interface is located.

## `route_filter_prefixes`{% #route_filter_prefixes %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `routeFilterPrefixes`**Description**: The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

- `cidr`**Type**: `STRING`**Provider name**: `cidr`**Description**: The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

## `site_link_enabled`{% #site_link_enabled %}

**Type**: `BOOLEAN`**Provider name**: `siteLinkEnabled`**Description**: Indicates whether SiteLink is enabled.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `virtual_gateway_id`{% #virtual_gateway_id %}

**Type**: `STRING`**Provider name**: `virtualGatewayId`**Description**: The ID of the virtual private gateway. Applies only to private virtual interfaces.

## `virtual_interface_arn`{% #virtual_interface_arn %}

**Type**: `STRING`

## `virtual_interface_id`{% #virtual_interface_id %}

**Type**: `STRING`**Provider name**: `virtualInterfaceId`**Description**: The ID of the virtual interface.

## `virtual_interface_name`{% #virtual_interface_name %}

**Type**: `STRING`**Provider name**: `virtualInterfaceName`**Description**: The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

## `virtual_interface_state`{% #virtual_interface_state %}

**Type**: `STRING`**Provider name**: `virtualInterfaceState`**Description**: The state of the virtual interface. The following are the possible values:

- `confirming`: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
- `verifying`: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
- `pending`: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
- `available`: A virtual interface that is able to forward traffic.
- `down`: A virtual interface that is BGP down.
- `deleting`: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
- `deleted`: A virtual interface that cannot forward traffic.
- `rejected`: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the `Confirming` state is deleted by the virtual interface owner, the virtual interface enters the `Rejected` state.
- `unknown`: The state of the virtual interface is not available.



## `virtual_interface_type`{% #virtual_interface_type %}

**Type**: `STRING`**Provider name**: `virtualInterfaceType`**Description**: The type of virtual interface. The possible values are `private` and `public`.

## `vlan`{% #vlan %}

**Type**: `INT32`**Provider name**: `vlan`**Description**: The ID of the VLAN.