View a markdown version of this page

ConnectionSummary - AWS Interconnect

ConnectionSummary

Summarized view of a Connection object.

Contents

arn

The ARN of the Connection

Type: String

Length Constraints: Minimum length of 59. Maximum length of 150.

Pattern: arn:aws[a-z-]*:interconnect:[^:]+:[0-9]{12}:connection/(mcc|lmcc)-[a-z0-9]{8}

Required: Yes

attachPoint

The Attach Point to which the Connection should be associated.

Type: AttachPoint object

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

Required: Yes

bandwidth

The bandwidth of the Connection

Type: String

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

Pattern: \d+[MG]bps

Required: Yes

description

A descriptive name of the Connection

Type: String

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

Pattern: [-a-zA-Z0-9_ ]+

Required: Yes

environmentId

The Environment that this Connection is created on.

Type: String

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

Required: Yes

id

The identifier of the requested Connection

Type: String

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

Pattern: (mcc|lmcc)-[a-z0-9]{8}

Required: Yes

location

The provider specific location at the remote end of this Connection

Type: String

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

Required: Yes

provider

The provider on the remote end 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

sharedId

An identifier used by both AWS and the remote partner to identify the specific Connection.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [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}

Required: Yes

state
  • 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.

Type: String

Valid Values: available | requested | pending | down | deleting | deleted | failed | updating

Required: Yes

type

The product variant supplied by this resource.

Type: String

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

Required: Yes

billingTier

The billing tier this Connection is currently assigned.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 8.

Required: No

See Also

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