environments

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

Overview

Name	environments
Type	Resource
Id	aws.interconnect.environments

Fields

The following fields are returned by SELECT queries:

get_environment

Name	Datatype	Description
activation_page_url	string	An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.
bandwidths	object	The sets of bandwidths that are available and supported on this environment.
environment_id	string	The identifier of this Environment
location	string	The provider specific location on the remote side of this Connection.
provider	object	The provider on the remote side of this Connection.
remote_identifier_type	string	The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment. (account, email)
state	string	The state of the Environment. Possible values: available: The environment is available and new Connection objects can be requested. limited: The environment is available, but overall capacity is limited. The set of available bandwidths unavailable: The environment is currently unavailable. (available, limited, unavailable)
type_	string	The specific product type of Connection objects provided by this Environment.

list_environments

Name	Datatype	Description
activation_page_url	string	An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.
bandwidths	object	The sets of bandwidths that are available and supported on this environment.
environment_id	string	The identifier of this Environment
location	string	The provider specific location on the remote side of this Connection.
provider	object	The provider on the remote side of this Connection.
remote_identifier_type	string	The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment. (account, email)
state	string	The state of the Environment. Possible values: available: The environment is available and new Connection objects can be requested. limited: The environment is available, but overall capacity is limited. The set of available bandwidths unavailable: The environment is currently unavailable. (available, limited, unavailable)
type_	string	The specific product type of Connection objects provided by this Environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment	select	region		Describes a specific Environment
list_environments	select	region		Lists all of the environments that can produce connections that will land in the called AWS region.

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_environment

Describes a specific Environment

SELECT
activation_page_url,
bandwidths,
environment_id,
location,
provider,
remote_identifier_type,
state,
type_
FROM aws.interconnect.environments
WHERE region = '{{ region }}' -- required
;

list_environments

Lists all of the environments that can produce connections that will land in the called AWS region.

SELECT
activation_page_url,
bandwidths,
environment_id,
location,
provider,
remote_identifier_type,
state,
type_
FROM aws.interconnect.environments
WHERE region = '{{ region }}' -- required
;