connections

Creates, updates, deletes, gets or lists a connections resource.

Overview

Name	connections
Type	Resource
Id	aws.interconnect.connections

Fields

The following fields are returned by SELECT queries:

get_connection

Name	Datatype	Description
id	string	The short identifier of the connection object. (pattern: <code>(mcc|lmcc)-[a-z0-9]{8}</code>)
activation_key	string	The Activation Key associated to this connection.
arn	string	An ARN of a Connection object. (pattern: <code>arn:aws[a-z-]*:interconnect:[^:]+:[0-9]{12}:connection/(mcc|lmcc)-[a-z0-9]{8}</code>)
attach_point	object	The Attach Point to which the connection should be associated."
bandwidth	string	The specific selected bandwidth of this connection. (pattern: <code>\d+[MG]bps</code>)
billing_tier	integer	The billing tier this connection is currently assigned.
description	string	A descriptive name for the connection. (pattern: <code>[-a-zA-Z0-9_ ]+</code>)
environment_id	string	The specific Environment this connection is placed upon.
location	string	The provider specific location on the remote side of this Connection
owner_account	string	The account that owns this Connection (pattern: <code>[0-9]{12}</code>)
provider	object	The provider on the remote side of this Connection.
shared_id	string	An identifier used by both AWS and the remote partner to identify the specific connection. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
state	string	requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal. pending: The connection has been accepted and is being provisioned between AWS and the Partner. available: The connection has been fully provisioned between AWS and the Partner. deleting: The connection is being deleted. deleted: The connection has been deleted. failed: The connection has failed to be created. updating: The connection is being updated. (available, requested, pending, down, deleting, deleted, failed, updating)
tags	object	The tags on the Connection
type_	string	The specific product type of this Connection.

list_connections

Name	Datatype	Description
id	string	The identifier of the requested Connection (pattern: <code>(mcc|lmcc)-[a-z0-9]{8}</code>)
arn	string	The ARN of the Connection (pattern: <code>arn:aws[a-z-]*:interconnect:[^:]+:[0-9]{12}:connection/(mcc|lmcc)-[a-z0-9]{8}</code>)
attach_point	object	The Attach Point to which the connection should be associated.
bandwidth	string	The bandwidth of the Connection (pattern: <code>\d+[MG]bps</code>)
billing_tier	integer	The billing tier this connection is currently assigned.
description	string	A descriptive name of the Connection (pattern: <code>[-a-zA-Z0-9_ ]+</code>)
environment_id	string	The Environment that this Connection is created on.
location	string	The provider specific location at the remote end of this Connection
provider	object	The provider on the remote end of this Connection
shared_id	string	An identifier used by both AWS and the remote partner to identify the specific connection. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
state	string	requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal. pending: The connection has been accepted and is being provisioned between AWS and the Partner. available: The connection has been fully provisioned between AWS and the Partner. deleting: The connection is being deleted. deleted: The connection has been deleted. failed: The connection has failed to be created. updating: The connection is being updated. (available, requested, pending, down, deleting, deleted, failed, updating)
type_	string	The product variant supplied by this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection	select	region		Describes the current state of a Connection resource as specified by the identifier.
list_connections	select	region		Lists all connection objects to which the caller has access. Allows for optional filtering by the following properties: state environmentId provider attach point Only Connection objects matching all filters will be returned.
create_connection	insert	region, bandwidth, attachPoint, environmentId		Initiates the process to create a Connection across the specified Environment. The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments The Attach Point specifies where within the AWS Network your connection will logically connect. After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner's portal to confirm the Connection on both sides. (See Environment$activationPageUrl for a direct link to the partner portal).
update_connection	update	region, identifier		Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.
delete_connection	delete	region		Deletes an existing Connection with the supplied identifier. This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.
accept_connection_proposal	exec	region, attachPoint, activationKey		Accepts a connection proposal which was generated at a supported partner's portal. The proposal contains the Environment and bandwidth that were chosen on the partner's portal and cannot be modified. Upon accepting the proposal a connection will be made between the AWS network as accessed via the selected Attach Point and the network previously selected network on the partner's portal.

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

get_connection

Describes the current state of a Connection resource as specified by the identifier.

SELECT
id,
activation_key,
arn,
attach_point,
bandwidth,
billing_tier,
description,
environment_id,
location,
owner_account,
provider,
shared_id,
state,
tags,
type_
FROM aws.interconnect.connections
WHERE region = '{{ region }}' -- required
;

list_connections

Lists all connection objects to which the caller has access. Allows for optional filtering by the following properties: state environmentId provider attach point Only Connection objects matching all filters will be returned.

SELECT
id,
arn,
attach_point,
bandwidth,
billing_tier,
description,
environment_id,
location,
provider,
shared_id,
state,
type_
FROM aws.interconnect.connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connection

Initiates the process to create a Connection across the specified Environment. The Environment dictates the specified partner and location to which the other end of the connection should attach. You can see a list of the available Environments by calling ListEnvironments The Attach Point specifies where within the AWS Network your connection will logically connect. After a successful call to this method, the resulting Connection will return an Activation Key which will need to be brought to the specific partner's portal to confirm the Connection on both sides. (See Environment$activationPageUrl for a direct link to the partner portal).

INSERT INTO aws.interconnect.connections (
description,
bandwidth,
attachPoint,
environmentId,
remoteAccount,
tags,
clientToken,
region
)
SELECT 
'{{ description }}',
'{{ bandwidth }}' /* required */,
'{{ attachPoint }}' /* required */,
'{{ environmentId }}' /* required */,
'{{ remoteAccount }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
connection
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connections resource.
  - name: description
    value: "{{ description }}"
    description: |
      A description to distinguish this Connection.
  - name: bandwidth
    value: "{{ bandwidth }}"
    description: |
      The desired bandwidth of the requested Connection
  - name: attachPoint
    description: |
      The Attach Point to which the connection should be associated."
    value:
      directConnectGateway: "{{ directConnectGateway }}"
      arn: "{{ arn }}"
  - name: environmentId
    value: "{{ environmentId }}"
    description: |
      The identifier of the Environment across which this Connection should be created. The available Environment objects can be determined using ListEnvironments.
  - name: remoteAccount
    description: |
      Account and/or principal identifying information that can be verified by the partner of this specific Environment.
    value:
      identifier: "{{ identifier }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The tag to associate with the resulting Connection.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotency token used for the request.

UPDATE examples

update_connection

Modifies an existing connection. Currently we support modifications to the connection's description and/or bandwidth.

UPDATE aws.interconnect.connections
SET 
identifier = '{{ identifier }}',
description = '{{ description }}',
bandwidth = '{{ bandwidth }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
connection;

DELETE examples

delete_connection

Deletes an existing Connection with the supplied identifier. This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.

DELETE FROM aws.interconnect.connections
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

accept_connection_proposal

Accepts a connection proposal which was generated at a supported partner's portal. The proposal contains the Environment and bandwidth that were chosen on the partner's portal and cannot be modified. Upon accepting the proposal a connection will be made between the AWS network as accessed via the selected Attach Point and the network previously selected network on the partner's portal.

EXEC aws.interconnect.connections.accept_connection_proposal 
@region='{{ region }}' --required 
@@json=
'{
"attachPoint": "{{ attachPoint }}", 
"activationKey": "{{ activationKey }}", 
"description": "{{ description }}", 
"tags": "{{ tags }}", 
"clientToken": "{{ clientToken }}"
}'
;