View a markdown version of this page

Environment - AWS Interconnect

Environment

Defines the logical topology that an AWS Interconnect Connection is created upon.

Specifically, an Environment defines the partner The remote Cloud Service Provider of this resource. or The remote Last Mile Provider of this resource. and the region or location specification to which an AWS Interconnect Connection can be made.

Contents

bandwidths

The sets of bandwidths that are available and supported on this environment.

Type: Bandwidths object

Required: Yes

environmentId

The identifier of this Environment

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

location

The provider specific location on the remote side of this Connection.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: Yes

provider

The provider on the remote side of this Connection.

Type: Provider object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

state

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.

Type: String

Valid Values: available | limited | unavailable

Required: Yes

type

The specific product type of Connection objects provided by this Environment.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 32.

Required: Yes

activationPageUrl

An HTTPS URL on the remote partner portal where the Activation Key should be brought to complete the creation process.

Type: String

Required: No

remoteIdentifierType

The type of identifying information that should be supplied to the remoteAccount parameter of a CreateConnection call for this specific Environment.

Type: String

Valid Values: account | email

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: