direct_connect_gateway_attachments
Creates, updates, deletes, gets or lists a direct_connect_gateway_attachments resource.
Overview
| Name | direct_connect_gateway_attachments |
| Type | Resource |
| Id | aws.directconnect.direct_connect_gateway_attachments |
Fields
The following fields are returned by SELECT queries:
- describe_direct_connect_gateway_attachments
| Name | Datatype | Description |
|---|---|---|
attachment_state | string | The state of the attachment. The following are the possible values: attaching: The initial state after a virtual interface is created using the Direct Connect gateway. attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic. detaching: The initial state after calling DeleteVirtualInterface. detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped. (attaching, attached, detaching, detached) |
attachment_type | string | The type of attachment. (TransitVirtualInterface, PrivateVirtualInterface) |
direct_connect_gateway_id | string | The ID of the Direct Connect gateway. |
state_change_error | string | The error message if the state of an object failed to advance. |
virtual_interface_id | string | The ID of the virtual interface. |
virtual_interface_owner_account | string | The ID of the Amazon Web Services account that owns the virtual interface. |
virtual_interface_region | string | The Amazon Web Services Region where the virtual interface is located. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_direct_connect_gateway_attachments | select | region | Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_direct_connect_gateway_attachments
Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.
SELECT
attachment_state,
attachment_type,
direct_connect_gateway_id,
state_change_error,
virtual_interface_id,
virtual_interface_owner_account,
virtual_interface_region
FROM aws.directconnect.direct_connect_gateway_attachments
WHERE region = '{{ region }}' -- required
;