interconnects

Creates, updates, deletes, gets or lists an interconnects resource.

Overview

Name	interconnects
Type	Resource
Id	aws.directconnect.interconnects

Fields

The following fields are returned by SELECT queries:

describe_interconnects

Name	Datatype	Description
interconnects	array	The interconnects.
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_interconnects	select	region		Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
create_interconnect	insert	region, interconnectName, bandwidth, location		Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner. Intended for use by Direct Connect Partners only.
allocate_connection_on_interconnect	update	region, bandwidth, connectionName, ownerAccount, interconnectId, vlan		Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by Direct Connect Partners only.
delete_interconnect	delete	region		Deletes the specified interconnect. Intended for use by Direct Connect Partners only.

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_interconnects

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

SELECT
interconnects,
next_token
FROM aws.directconnect.interconnects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_interconnect

Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location. An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router. You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created. For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner. Intended for use by Direct Connect Partners only.

INSERT INTO aws.directconnect.interconnects (
interconnectName,
bandwidth,
location,
lagId,
tags,
providerName,
requestMACSec,
region
)
SELECT 
'{{ interconnectName }}' /* required */,
'{{ bandwidth }}' /* required */,
'{{ location }}' /* required */,
'{{ lagId }}',
'{{ tags }}',
'{{ providerName }}',
{{ requestMACSec }},
'{{ region }}'
RETURNING
aws_device,
aws_device_v2,
aws_logical_device_id,
bandwidth,
encryption_mode,
has_logical_redundancy,
interconnect_id,
interconnect_name,
interconnect_state,
jumbo_frame_capable,
lag_id,
loa_issue_time,
location,
mac_sec_capable,
mac_sec_keys,
port_encryption_status,
provider_name,
region,
tags
;

Manifest

# Description fields are for documentation purposes
- name: interconnects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the interconnects resource.
  - name: interconnectName
    value: "{{ interconnectName }}"
    description: |
      The name of the interconnect.
  - name: bandwidth
    value: "{{ bandwidth }}"
    description: |
      The port bandwidth, in Gbps. The possible values are 1, 10, and 100.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the interconnect.
  - name: lagId
    value: "{{ lagId }}"
    description: |
      The ID of the LAG.
  - name: tags
    description: |
      The tags to associate with the interconnect.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: providerName
    value: "{{ providerName }}"
    description: |
      The name of the service provider associated with the interconnect.
  - name: requestMACSec
    value: {{ requestMACSec }}
    description: |
      Indicates whether you want the interconnect to support MAC Security (MACsec).

UPDATE examples

allocate_connection_on_interconnect

Deprecated. Use AllocateHostedConnection instead. Creates a hosted connection on an interconnect. Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect. Intended for use by Direct Connect Partners only.

UPDATE aws.directconnect.interconnects
SET 
bandwidth = '{{ bandwidth }}',
connectionName = '{{ connectionName }}',
ownerAccount = '{{ ownerAccount }}',
interconnectId = '{{ interconnectId }}',
vlan = {{ vlan }}
WHERE 
region = '{{ region }}' --required
AND bandwidth = '{{ bandwidth }}' --required
AND connectionName = '{{ connectionName }}' --required
AND ownerAccount = '{{ ownerAccount }}' --required
AND interconnectId = '{{ interconnectId }}' --required
AND vlan = '{{ vlan }}' --required
RETURNING
aws_device,
aws_device_v2,
aws_logical_device_id,
bandwidth,
connection_id,
connection_name,
connection_state,
encryption_mode,
has_logical_redundancy,
jumbo_frame_capable,
lag_id,
loa_issue_time,
location,
mac_sec_capable,
mac_sec_keys,
owner_account,
partner_interconnect_mac_sec_capable,
partner_name,
port_encryption_status,
provider_name,
rate_limiter_status,
region,
tags,
vlan;

DELETE examples

delete_interconnect

Deletes the specified interconnect. Intended for use by Direct Connect Partners only.

DELETE FROM aws.directconnect.interconnects
WHERE region = '{{ region }}' --required
;