Class: AWS.DirectConnect

Inherits:
AWS.Service show all
Identifier:
directconnect
API Version:
2012-10-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using DirectConnect

var directconnect = new AWS.DirectConnect();
directconnect.allocateConnectionOnInterconnect(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DirectConnect object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var directconnect = new AWS.DirectConnect({apiVersion: '2012-10-25'});

You can also set the API version globally in AWS.config.apiVersions using the directconnect service identifier:

AWS.config.apiVersions = {
  directconnect: '2012-10-25',
  // other service API versions
};

var directconnect = new AWS.DirectConnect();

Version:

  • 2012-10-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DirectConnect(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DirectConnect object

var directconnect = new AWS.DirectConnect({apiVersion: '2012-10-25'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DirectConnect.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DirectConnect.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DirectConnect.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

allocateConnectionOnInterconnect(params = {}, callback) ⇒ AWS.Request

Deprecated in favor of AllocateHostedConnection.

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 given interconnect.

Note: This is intended for use by AWS Direct Connect partners only.

Examples:

Calling the allocateConnectionOnInterconnect operation

var params = {
  bandwidth: 'STRING_VALUE', /* required */
  connectionName: 'STRING_VALUE', /* required */
  interconnectId: 'STRING_VALUE', /* required */
  ownerAccount: 'STRING_VALUE', /* required */
  vlan: 0 /* required */
};
directconnect.allocateConnectionOnInterconnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • bandwidth — (String)

      Bandwidth of the connection.

      Example: "500Mbps"

      Default: None

      Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

    • connectionName — (String)

      Name of the provisioned connection.

      Example: "500M Connection to AWS"

      Default: None

    • ownerAccount — (String)

      Numeric account Id of the customer for whom the connection will be provisioned.

      Example: 123443215678

      Default: None

    • interconnectId — (String)

      ID of the interconnect on which the connection will be provisioned.

      Example: dxcon-456abc78

      Default: None

    • vlan — (Integer)

      The dedicated VLAN provisioned to the connection.

      Example: 101

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

allocateHostedConnection(params = {}, callback) ⇒ AWS.Request

Creates a hosted connection on an interconnect or a link aggregation group (LAG).

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect or LAG.

Note: This is intended for use by AWS Direct Connect partners only.

Service Reference:

Examples:

Calling the allocateHostedConnection operation

var params = {
  bandwidth: 'STRING_VALUE', /* required */
  connectionId: 'STRING_VALUE', /* required */
  connectionName: 'STRING_VALUE', /* required */
  ownerAccount: 'STRING_VALUE', /* required */
  vlan: 0 /* required */
};
directconnect.allocateHostedConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the interconnect or LAG on which the connection will be provisioned.

      Example: dxcon-456abc78 or dxlag-abc123

      Default: None

    • ownerAccount — (String)

      The numeric account ID of the customer for whom the connection will be provisioned.

      Example: 123443215678

      Default: None

    • bandwidth — (String)

      The bandwidth of the connection.

      Example: 500Mbps

      Default: None

      Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

    • connectionName — (String)

      The name of the provisioned connection.

      Example: "500M Connection to AWS"

      Default: None

    • vlan — (Integer)

      The dedicated VLAN provisioned to the hosted connection.

      Example: 101

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

allocatePrivateVirtualInterface(params = {}, callback) ⇒ AWS.Request

Provisions a private virtual interface to be owned by another AWS customer.

Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the ConfirmPrivateVirtualInterface action. Until then, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

Service Reference:

Examples:

Calling the allocatePrivateVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPrivateVirtualInterfaceAllocation: { /* required */
    asn: 0, /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 0, /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE'
  },
  ownerAccount: 'STRING_VALUE' /* required */
};
directconnect.allocatePrivateVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The connection ID on which the private virtual interface is provisioned.

      Default: None

    • ownerAccount — (String)

      The AWS account that will own the new private virtual interface.

      Default: None

    • newPrivateVirtualInterfaceAllocation — (map)

      Detailed information for the private virtual interface to be provisioned.

      Default: None

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlanrequired — (Integer)

        The VLAN ID.

        Example: 101

      • asnrequired — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType — (String)

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn — (Integer)

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • customerRouterConfig — (String)

        Information for generating the customer router configuration.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers — (Array<map>)

        A list of the BGP peers configured on this virtual interface.

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState — (String)

          The state of the BGP peer.

          • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

          • Available: The BGP peer can be established.

          • Deleting: The BGP peer is in the process of being deleted.

          • Deleted: The BGP peer has been deleted and cannot be established.

          Possible values include:
          • "verifying"
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • bgpStatus — (String)

          The Up/Down state of the BGP peer.

          • Up: The BGP peer is established.

          • Down: The BGP peer is down.

          Possible values include:
          • "up"
          • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

allocatePublicVirtualInterface(params = {}, callback) ⇒ AWS.Request

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

Service Reference:

Examples:

Calling the allocatePublicVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPublicVirtualInterfaceAllocation: { /* required */
    asn: 0, /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 0, /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    routeFilterPrefixes: [
      {
        cidr: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  ownerAccount: 'STRING_VALUE' /* required */
};
directconnect.allocatePublicVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The connection ID on which the public virtual interface is provisioned.

      Default: None

    • ownerAccount — (String)

      The AWS account that will own the new public virtual interface.

      Default: None

    • newPublicVirtualInterfaceAllocation — (map)

      Detailed information for the public virtual interface to be provisioned.

      Default: None

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlanrequired — (Integer)

        The VLAN ID.

        Example: 101

      • asnrequired — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType — (String)

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn — (Integer)

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • customerRouterConfig — (String)

        Information for generating the customer router configuration.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers — (Array<map>)

        A list of the BGP peers configured on this virtual interface.

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState — (String)

          The state of the BGP peer.

          • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

          • Available: The BGP peer can be established.

          • Deleting: The BGP peer is in the process of being deleted.

          • Deleted: The BGP peer has been deleted and cannot be established.

          Possible values include:
          • "verifying"
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • bgpStatus — (String)

          The Up/Down state of the BGP peer.

          • Up: The BGP peer is established.

          • Down: The BGP peer is down.

          Possible values include:
          • "up"
          • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateConnectionWithLag(params = {}, callback) ⇒ AWS.Request

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS will be interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can reassociate a connection that's currently associated with a different LAG; however, if removing the connection will cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

Service Reference:

Examples:

Calling the associateConnectionWithLag operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  lagId: 'STRING_VALUE' /* required */
};
directconnect.associateConnectionWithLag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection.

      Example: dxcon-abc123

      Default: None

    • lagId — (String)

      The ID of the LAG with which to associate the connection.

      Example: dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateHostedConnection(params = {}, callback) ⇒ AWS.Request

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.

Note: This is intended for use by AWS Direct Connect partners only.

Service Reference:

Examples:

Calling the associateHostedConnection operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  parentConnectionId: 'STRING_VALUE' /* required */
};
directconnect.associateHostedConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the hosted connection.

      Example: dxcon-abc123

      Default: None

    • parentConnectionId — (String)

      The ID of the interconnect or the LAG.

      Example: dxcon-abc123 or dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateVirtualInterface(params = {}, callback) ⇒ AWS.Request

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.

Service Reference:

Examples:

Calling the associateVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  virtualInterfaceId: 'STRING_VALUE' /* required */
};
directconnect.associateVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

    • connectionId — (String)

      The ID of the LAG or connection with which to associate the virtual interface.

      Example: dxlag-abc123 or dxcon-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType — (String)

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn — (Integer)

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • customerRouterConfig — (String)

        Information for generating the customer router configuration.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers — (Array<map>)

        A list of the BGP peers configured on this virtual interface.

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState — (String)

          The state of the BGP peer.

          • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

          • Available: The BGP peer can be established.

          • Deleting: The BGP peer is in the process of being deleted.

          • Deleted: The BGP peer has been deleted and cannot be established.

          Possible values include:
          • "verifying"
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • bgpStatus — (String)

          The Up/Down state of the BGP peer.

          • Up: The BGP peer is established.

          • Down: The BGP peer is down.

          Possible values include:
          • "up"
          • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

confirmConnection(params = {}, callback) ⇒ AWS.Request

Confirm the creation of a hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

Service Reference:

Examples:

Calling the confirmConnection operation

var params = {
  connectionId: 'STRING_VALUE' /* required */
};
directconnect.confirmConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

confirmPrivateVirtualInterface(params = {}, callback) ⇒ AWS.Request

Accept ownership of a private virtual interface created by another customer.

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway or direct connect gateway, and will be available for handling traffic.

Service Reference:

Examples:

Calling the confirmPrivateVirtualInterface operation

var params = {
  virtualInterfaceId: 'STRING_VALUE', /* required */
  directConnectGatewayId: 'STRING_VALUE',
  virtualGatewayId: 'STRING_VALUE'
};
directconnect.confirmPrivateVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

    • virtualGatewayId — (String)

      ID of the virtual private gateway that will be attached to the virtual interface.

      A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

      Default: None

    • directConnectGatewayId — (String)

      ID of the direct connect gateway that will be attached to the virtual interface.

      A direct connect gateway can be managed via the AWS Direct Connect console or the CreateDirectConnectGateway action.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

confirmPublicVirtualInterface(params = {}, callback) ⇒ AWS.Request

Accept ownership of a public virtual interface created by another customer.

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

Service Reference:

Examples:

Calling the confirmPublicVirtualInterface operation

var params = {
  virtualInterfaceId: 'STRING_VALUE' /* required */
};
directconnect.confirmPublicVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBGPPeer(params = {}, callback) ⇒ AWS.Request

Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.

You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.

When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

Service Reference:

Examples:

Calling the createBGPPeer operation

var params = {
  newBGPPeer: {
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    asn: 0,
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE'
  },
  virtualInterfaceId: 'STRING_VALUE'
};
directconnect.createBGPPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface on which the BGP peer will be provisioned.

      Example: dxvif-456abc78

      Default: None

    • newBGPPeer — (map)

      Detailed information for the BGP peer to be created.

      Default: None

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterface — (map)

        A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

        • ownerAccount — (String)

          The AWS account that will own the new virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

          Example: dxvif-123dfg56

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • virtualInterfaceType — (String)

          The type of virtual interface.

          Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer.

          Example: "My VPC"

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • virtualInterfaceState — (String)

          State of the virtual interface.

          • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

          • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

          • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

          • Available: A virtual interface that is able to forward traffic.

          • Down: A virtual interface that is BGP down.

          • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

          • Deleted: A virtual interface that cannot forward traffic.

          • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

          Possible values include:
          • "confirming"
          • "verifying"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • customerRouterConfig — (String)

          Information for generating the customer router configuration.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • routeFilterPrefixes — (Array<map>)

          A list of routes to be advertised to the AWS network in this region (public virtual interface).

          • cidr — (String)

            CIDR notation for the advertised route. Multiple routes are separated by commas.

            IPv6 CIDRs must be at least a /64 or shorter

            Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

        • bgpPeers — (Array<map>)

          A list of the BGP peers configured on this virtual interface.

          • asn — (Integer)

            The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

            Example: 65000

          • authKey — (String)

            The authentication key for BGP configuration.

            Example: asdf34example

          • addressFamily — (String)

            Indicates the address family for the BGP peer.

            • ipv4: IPv4 address family

            • ipv6: IPv6 address family

            Possible values include:
            • "ipv4"
            • "ipv6"
          • amazonAddress — (String)

            IP address assigned to the Amazon interface.

            Example: 192.168.1.1/30 or 2001:db8::1/125

          • customerAddress — (String)

            IP address assigned to the customer interface.

            Example: 192.168.1.2/30 or 2001:db8::2/125

          • bgpPeerState — (String)

            The state of the BGP peer.

            • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

            • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

            • Available: The BGP peer can be established.

            • Deleting: The BGP peer is in the process of being deleted.

            • Deleted: The BGP peer has been deleted and cannot be established.

            Possible values include:
            • "verifying"
            • "pending"
            • "available"
            • "deleting"
            • "deleted"
          • bgpStatus — (String)

            The Up/Down state of the BGP peer.

            • Up: The BGP peer is established.

            • Down: The BGP peer is down.

            Possible values include:
            • "up"
            • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createConnection(params = {}, callback) ⇒ AWS.Request

Creates a new connection between the customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

To find the locations for your region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.

Service Reference:

Examples:

Calling the createConnection operation

var params = {
  bandwidth: 'STRING_VALUE', /* required */
  connectionName: 'STRING_VALUE', /* required */
  location: 'STRING_VALUE', /* required */
  lagId: 'STRING_VALUE'
};
directconnect.createConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • location — (String)

      Where the connection is located.

      Example: EqSV5

      Default: None

    • bandwidth — (String)

      Bandwidth of the connection.

      Example: 1Gbps

      Default: None

    • connectionName — (String)

      The name of the connection.

      Example: "My Connection to AWS"

      Default: None

    • lagId — (String)

      The ID of the LAG.

      Example: dxlag-fg5678gh

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDirectConnectGateway(params = {}, callback) ⇒ AWS.Request

Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.

Service Reference:

Examples:

Calling the createDirectConnectGateway operation

var params = {
  directConnectGatewayName: 'STRING_VALUE', /* required */
  amazonSideAsn: 0
};
directconnect.createDirectConnectGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayName — (String)

      The name of the direct connect gateway.

      Example: "My direct connect gateway"

      Default: None

    • amazonSideAsn — (Integer)

      The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294

      Example: 65200

      Default: 64512

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGateway — (map)

        The direct connect gateway to be created.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • directConnectGatewayName — (String)

          The name of the direct connect gateway.

          Example: "My direct connect gateway"

          Default: None

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • ownerAccount — (String)

          The AWS account ID of the owner of the direct connect gateway.

        • directConnectGatewayState — (String)

          State of the direct connect gateway.

          • Pending: The initial state after calling CreateDirectConnectGateway.

          • Available: The direct connect gateway is ready for use.

          • Deleting: The initial state after calling DeleteDirectConnectGateway.

          • Deleted: The direct connect gateway is deleted and cannot pass traffic.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDirectConnectGatewayAssociation(params = {}, callback) ⇒ AWS.Request

Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.

Examples:

Calling the createDirectConnectGatewayAssociation operation

var params = {
  directConnectGatewayId: 'STRING_VALUE', /* required */
  virtualGatewayId: 'STRING_VALUE' /* required */
};
directconnect.createDirectConnectGatewayAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

      Example: "vgw-abc123ef"

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGatewayAssociation — (map)

        The direct connect gateway association to be created.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • virtualGatewayRegion — (String)

          The region in which the virtual private gateway is located.

          Example: us-east-1

        • virtualGatewayOwnerAccount — (String)

          The AWS account ID of the owner of the virtual private gateway.

        • associationState — (String)

          State of the direct connect gateway association.

          • Associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • Associated: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

          • Disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • Disassociated: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createInterconnect(params = {}, callback) ⇒ AWS.Request

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS 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 AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

Note: This is intended for use by AWS Direct Connect partners only.

Service Reference:

Examples:

Calling the createInterconnect operation

var params = {
  bandwidth: 'STRING_VALUE', /* required */
  interconnectName: 'STRING_VALUE', /* required */
  location: 'STRING_VALUE', /* required */
  lagId: 'STRING_VALUE'
};
directconnect.createInterconnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • interconnectName — (String)

      The name of the interconnect.

      Example: "1G Interconnect to AWS"

      Default: None

    • bandwidth — (String)

      The port bandwidth

      Example: 1Gbps

      Default: None

      Available values: 1Gbps,10Gbps

    • location — (String)

      Where the interconnect is located

      Example: EqSV5

      Default: None

    • lagId — (String)

      The ID of the LAG.

      Example: dxlag-fg5678gh

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • interconnectId — (String)

        The ID of the interconnect.

        Example: dxcon-abc123

      • interconnectName — (String)

        The name of the interconnect.

        Example: "1G Interconnect to AWS"

      • interconnectState — (String)

        State of the interconnect.

        • Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The interconnect has been approved, and is being initialized.

        • Available: The network link is up, and the interconnect is ready for use.

        • Down: The network link is down.

        • Deleting: The interconnect is in the process of being deleted.

        • Deleted: The interconnect has been deleted.

        Possible values include:
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps

        Default: None

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createLag(params = {}, callback) ⇒ AWS.Request

Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

Service Reference:

Examples:

Calling the createLag operation

var params = {
  connectionsBandwidth: 'STRING_VALUE', /* required */
  lagName: 'STRING_VALUE', /* required */
  location: 'STRING_VALUE', /* required */
  numberOfConnections: 0, /* required */
  connectionId: 'STRING_VALUE'
};
directconnect.createLag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • numberOfConnections — (Integer)

      The number of physical connections initially provisioned and bundled by the LAG.

      Default: None

    • location — (String)

      The AWS Direct Connect location in which the LAG should be allocated.

      Example: EqSV5

      Default: None

    • connectionsBandwidth — (String)

      The bandwidth of the individual physical connections bundled by the LAG.

      Default: None

      Available values: 1Gbps, 10Gbps

    • lagName — (String)

      The name of the LAG.

      Example: "3x10G LAG to AWS"

      Default: None

    • connectionId — (String)

      The ID of an existing connection to migrate to the LAG.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectionsBandwidth — (String)

        The individual bandwidth of the physical connections bundled by the LAG.

        Available values: 1Gbps, 10Gbps

      • numberOfConnections — (Integer)

        The number of physical connections bundled by the LAG, up to a maximum of 10.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • ownerAccount — (String)

        The owner of the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG.

        • Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

        • Pending: The LAG has been approved, and is being initialized.

        • Available: The network link is established, and the LAG is ready for use.

        • Down: The network link is down.

        • Deleting: The LAG is in the process of being deleted.

        • Deleted: The LAG has been deleted.

        Possible values include:
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

      • awsDevice — (String)

        The AWS Direct Connection endpoint that hosts the LAG.

      • connections — (Array<map>)

        A list of connections bundled by this LAG.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

        Note: This is intended for use by AWS Direct Connect partners only.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPrivateVirtualInterface(params = {}, callback) ⇒ AWS.Request

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

Service Reference:

Examples:

Calling the createPrivateVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPrivateVirtualInterface: { /* required */
    asn: 0, /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 0, /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    directConnectGatewayId: 'STRING_VALUE',
    virtualGatewayId: 'STRING_VALUE'
  }
};
directconnect.createPrivateVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • newPrivateVirtualInterface — (map)

      Detailed information for the private virtual interface to be created.

      Default: None

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlanrequired — (Integer)

        The VLAN ID.

        Example: 101

      • asnrequired — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType — (String)

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn — (Integer)

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • customerRouterConfig — (String)

        Information for generating the customer router configuration.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers — (Array<map>)

        A list of the BGP peers configured on this virtual interface.

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState — (String)

          The state of the BGP peer.

          • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

          • Available: The BGP peer can be established.

          • Deleting: The BGP peer is in the process of being deleted.

          • Deleted: The BGP peer has been deleted and cannot be established.

          Possible values include:
          • "verifying"
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • bgpStatus — (String)

          The Up/Down state of the BGP peer.

          • Up: The BGP peer is established.

          • Down: The BGP peer is down.

          Possible values include:
          • "up"
          • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPublicVirtualInterface(params = {}, callback) ⇒ AWS.Request

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

Service Reference:

Examples:

Calling the createPublicVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPublicVirtualInterface: { /* required */
    asn: 0, /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 0, /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    routeFilterPrefixes: [
      {
        cidr: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
directconnect.createPublicVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • newPublicVirtualInterface — (map)

      Detailed information for the public virtual interface to be created.

      Default: None

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlanrequired — (Integer)

        The VLAN ID.

        Example: 101

      • asnrequired — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

        Example: dxvif-123dfg56

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • virtualInterfaceType — (String)

        The type of virtual interface.

        Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer.

        Example: "My VPC"

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • asn — (Integer)

        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

        Example: 65000

      • amazonSideAsn — (Integer)

        The autonomous system number (ASN) for the Amazon side of the connection.

      • authKey — (String)

        The authentication key for BGP configuration.

        Example: asdf34example

      • amazonAddress — (String)

        IP address assigned to the Amazon interface.

        Example: 192.168.1.1/30 or 2001:db8::1/125

      • customerAddress — (String)

        IP address assigned to the customer interface.

        Example: 192.168.1.2/30 or 2001:db8::2/125

      • addressFamily — (String)

        Indicates the address family for the BGP peer.

        • ipv4: IPv4 address family

        • ipv6: IPv6 address family

        Possible values include:
        • "ipv4"
        • "ipv6"
      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • customerRouterConfig — (String)

        Information for generating the customer router configuration.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

        Example: vgw-123er56

      • directConnectGatewayId — (String)

        The ID of the direct connect gateway.

        Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      • routeFilterPrefixes — (Array<map>)

        A list of routes to be advertised to the AWS network in this region (public virtual interface).

        • cidr — (String)

          CIDR notation for the advertised route. Multiple routes are separated by commas.

          IPv6 CIDRs must be at least a /64 or shorter

          Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

      • bgpPeers — (Array<map>)

        A list of the BGP peers configured on this virtual interface.

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • bgpPeerState — (String)

          The state of the BGP peer.

          • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

          • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

          • Available: The BGP peer can be established.

          • Deleting: The BGP peer is in the process of being deleted.

          • Deleted: The BGP peer has been deleted and cannot be established.

          Possible values include:
          • "verifying"
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • bgpStatus — (String)

          The Up/Down state of the BGP peer.

          • Up: The BGP peer is established.

          • Down: The BGP peer is down.

          Possible values include:
          • "up"
          • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBGPPeer(params = {}, callback) ⇒ AWS.Request

Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

Service Reference:

Examples:

Calling the deleteBGPPeer operation

var params = {
  asn: 0,
  customerAddress: 'STRING_VALUE',
  virtualInterfaceId: 'STRING_VALUE'
};
directconnect.deleteBGPPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface from which the BGP peer will be deleted.

      Example: dxvif-456abc78

      Default: None

    • asn — (Integer)

      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      Example: 65000

    • customerAddress — (String)

      IP address assigned to the customer interface.

      Example: 192.168.1.2/30 or 2001:db8::2/125

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterface — (map)

        A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

        • ownerAccount — (String)

          The AWS account that will own the new virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

          Example: dxvif-123dfg56

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • virtualInterfaceType — (String)

          The type of virtual interface.

          Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer.

          Example: "My VPC"

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • virtualInterfaceState — (String)

          State of the virtual interface.

          • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

          • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

          • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

          • Available: A virtual interface that is able to forward traffic.

          • Down: A virtual interface that is BGP down.

          • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

          • Deleted: A virtual interface that cannot forward traffic.

          • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

          Possible values include:
          • "confirming"
          • "verifying"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • customerRouterConfig — (String)

          Information for generating the customer router configuration.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • routeFilterPrefixes — (Array<map>)

          A list of routes to be advertised to the AWS network in this region (public virtual interface).

          • cidr — (String)

            CIDR notation for the advertised route. Multiple routes are separated by commas.

            IPv6 CIDRs must be at least a /64 or shorter

            Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

        • bgpPeers — (Array<map>)

          A list of the BGP peers configured on this virtual interface.

          • asn — (Integer)

            The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

            Example: 65000

          • authKey — (String)

            The authentication key for BGP configuration.

            Example: asdf34example

          • addressFamily — (String)

            Indicates the address family for the BGP peer.

            • ipv4: IPv4 address family

            • ipv6: IPv6 address family

            Possible values include:
            • "ipv4"
            • "ipv6"
          • amazonAddress — (String)

            IP address assigned to the Amazon interface.

            Example: 192.168.1.1/30 or 2001:db8::1/125

          • customerAddress — (String)

            IP address assigned to the customer interface.

            Example: 192.168.1.2/30 or 2001:db8::2/125

          • bgpPeerState — (String)

            The state of the BGP peer.

            • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

            • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

            • Available: The BGP peer can be established.

            • Deleting: The BGP peer is in the process of being deleted.

            • Deleted: The BGP peer has been deleted and cannot be established.

            Possible values include:
            • "verifying"
            • "pending"
            • "available"
            • "deleting"
            • "deleted"
          • bgpStatus — (String)

            The Up/Down state of the BGP peer.

            • Up: The BGP peer is established.

            • Down: The BGP peer is down.

            Possible values include:
            • "up"
            • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConnection(params = {}, callback) ⇒ AWS.Request

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

Service Reference:

Examples:

Calling the deleteConnection operation

var params = {
  connectionId: 'STRING_VALUE' /* required */
};
directconnect.deleteConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDirectConnectGateway(params = {}, callback) ⇒ AWS.Request

Deletes a direct connect gateway. You must first delete all virtual interfaces that are attached to the direct connect gateway and disassociate all virtual private gateways that are associated with the direct connect gateway.

Service Reference:

Examples:

Calling the deleteDirectConnectGateway operation

var params = {
  directConnectGatewayId: 'STRING_VALUE' /* required */
};
directconnect.deleteDirectConnectGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGateway — (map)

        The direct connect gateway to be deleted.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • directConnectGatewayName — (String)

          The name of the direct connect gateway.

          Example: "My direct connect gateway"

          Default: None

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • ownerAccount — (String)

          The AWS account ID of the owner of the direct connect gateway.

        • directConnectGatewayState — (String)

          State of the direct connect gateway.

          • Pending: The initial state after calling CreateDirectConnectGateway.

          • Available: The direct connect gateway is ready for use.

          • Deleting: The initial state after calling DeleteDirectConnectGateway.

          • Deleted: The direct connect gateway is deleted and cannot pass traffic.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDirectConnectGatewayAssociation(params = {}, callback) ⇒ AWS.Request

Deletes the association between a direct connect gateway and a virtual private gateway.

Examples:

Calling the deleteDirectConnectGatewayAssociation operation

var params = {
  directConnectGatewayId: 'STRING_VALUE', /* required */
  virtualGatewayId: 'STRING_VALUE' /* required */
};
directconnect.deleteDirectConnectGatewayAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

      Example: "vgw-abc123ef"

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGatewayAssociation — (map)

        The direct connect gateway association to be deleted.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • virtualGatewayRegion — (String)

          The region in which the virtual private gateway is located.

          Example: us-east-1

        • virtualGatewayOwnerAccount — (String)

          The AWS account ID of the owner of the virtual private gateway.

        • associationState — (String)

          State of the direct connect gateway association.

          • Associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • Associated: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

          • Disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • Disassociated: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteInterconnect(params = {}, callback) ⇒ AWS.Request

Deletes the specified interconnect.

Note: This is intended for use by AWS Direct Connect partners only.

Service Reference:

Examples:

Calling the deleteInterconnect operation

var params = {
  interconnectId: 'STRING_VALUE' /* required */
};
directconnect.deleteInterconnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • interconnectId — (String)

      The ID of the interconnect.

      Example: dxcon-abc123

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • interconnectState — (String)

        State of the interconnect.

        • Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The interconnect has been approved, and is being initialized.

        • Available: The network link is up, and the interconnect is ready for use.

        • Down: The network link is down.

        • Deleting: The interconnect is in the process of being deleted.

        • Deleted: The interconnect has been deleted.

        Possible values include:
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLag(params = {}, callback) ⇒ AWS.Request

Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

Service Reference:

Examples:

Calling the deleteLag operation

var params = {
  lagId: 'STRING_VALUE' /* required */
};
directconnect.deleteLag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • lagId — (String)

      The ID of the LAG to delete.

      Example: dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectionsBandwidth — (String)

        The individual bandwidth of the physical connections bundled by the LAG.

        Available values: 1Gbps, 10Gbps

      • numberOfConnections — (Integer)

        The number of physical connections bundled by the LAG, up to a maximum of 10.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • ownerAccount — (String)

        The owner of the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG.

        • Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

        • Pending: The LAG has been approved, and is being initialized.

        • Available: The network link is established, and the LAG is ready for use.

        • Down: The network link is down.

        • Deleting: The LAG is in the process of being deleted.

        • Deleted: The LAG has been deleted.

        Possible values include:
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

      • awsDevice — (String)

        The AWS Direct Connection endpoint that hosts the LAG.

      • connections — (Array<map>)

        A list of connections bundled by this LAG.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

        Note: This is intended for use by AWS Direct Connect partners only.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVirtualInterface(params = {}, callback) ⇒ AWS.Request

Deletes a virtual interface.

Service Reference:

Examples:

Calling the deleteVirtualInterface operation

var params = {
  virtualInterfaceId: 'STRING_VALUE' /* required */
};
directconnect.deleteVirtualInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterfaceState — (String)

        State of the virtual interface.

        • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

        • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

        • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

        • Available: A virtual interface that is able to forward traffic.

        • Down: A virtual interface that is BGP down.

        • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

        • Deleted: A virtual interface that cannot forward traffic.

        • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

        Possible values include:
        • "confirming"
        • "verifying"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeConnectionLoa(params = {}, callback) ⇒ AWS.Request

Deprecated in favor of DescribeLoa.

Returns the LOA-CFA for a Connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

Service Reference:

Examples:

Calling the describeConnectionLoa operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  loaContentType: application/pdf,
  providerName: 'STRING_VALUE'
};
directconnect.describeConnectionLoa(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • providerName — (String)

      The name of the APN partner or service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

      Default: None

    • loaContentType — (String)

      A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

      Default: application/pdf

      Possible values include:
      • "application/pdf"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • loa — (map)

        A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

        • loaContent — (Buffer, Typed Array, Blob, String)

          The binary contents of the LOA-CFA document.

        • loaContentType — (String)

          A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

          Default: application/pdf

          Possible values include:
          • "application/pdf"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeConnections(params = {}, callback) ⇒ AWS.Request

Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

Service Reference:

Examples:

Calling the describeConnections operation

var params = {
  connectionId: 'STRING_VALUE'
};
directconnect.describeConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connections — (Array<map>)

        A list of connections.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeConnectionsOnInterconnect(params = {}, callback) ⇒ AWS.Request

Deprecated in favor of DescribeHostedConnections.

Returns a list of connections that have been provisioned on the given interconnect.

Note: This is intended for use by AWS Direct Connect partners only.

Examples:

Calling the describeConnectionsOnInterconnect operation

var params = {
  interconnectId: 'STRING_VALUE' /* required */
};
directconnect.describeConnectionsOnInterconnect(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • interconnectId — (String)

      ID of the interconnect on which a list of connection is provisioned.

      Example: dxcon-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connections — (Array<map>)

        A list of connections.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDirectConnectGatewayAssociations(params = {}, callback) ⇒ AWS.Request

Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.

Examples:

Calling the describeDirectConnectGatewayAssociations operation

var params = {
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 0,
  nextToken: 'STRING_VALUE',
  virtualGatewayId: 'STRING_VALUE'
};
directconnect.describeDirectConnectGatewayAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

      Example: "vgw-abc123ef"

      Default: None

    • maxResults — (Integer)

      The maximum number of direct connect gateway associations to return per page.

      Example: 15

      Default: None

    • nextToken — (String)

      The token provided in the previous describe result to retrieve the next page of the result.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGatewayAssociations — (Array<map>)

        Information about the direct connect gateway associations.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • virtualGatewayRegion — (String)

          The region in which the virtual private gateway is located.

          Example: us-east-1

        • virtualGatewayOwnerAccount — (String)

          The AWS account ID of the owner of the virtual private gateway.

        • associationState — (String)

          State of the direct connect gateway association.

          • Associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • Associated: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.

          • Disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • Disassociated: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.

          Possible values include:
          • "associating"
          • "associated"
          • "disassociating"
          • "disassociated"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

      • nextToken — (String)

        Token to retrieve the next page of the result.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDirectConnectGatewayAttachments(params = {}, callback) ⇒ AWS.Request

Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.

Examples:

Calling the describeDirectConnectGatewayAttachments operation

var params = {
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 0,
  nextToken: 'STRING_VALUE',
  virtualInterfaceId: 'STRING_VALUE'
};
directconnect.describeDirectConnectGatewayAttachments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: "dxvif-abc123ef"

      Default: None

    • maxResults — (Integer)

      The maximum number of direct connect gateway attachments to return per page.

      Example: 15

      Default: None

    • nextToken — (String)

      The token provided in the previous describe result to retrieve the next page of the result.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGatewayAttachments — (Array<map>)

        Information about the direct connect gateway attachments.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

          Example: dxvif-123dfg56

          Default: None

        • virtualInterfaceRegion — (String)

          The region in which the virtual interface is located.

          Example: us-east-1

        • virtualInterfaceOwnerAccount — (String)

          The AWS account ID of the owner of the virtual interface.

        • attachmentState — (String)

          State of the direct connect gateway attachment.

          • Attaching: The initial state after a virtual interface is created using the direct connect gateway.

          • Attached: The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.

          • Detaching: The initial state after calling DeleteVirtualInterface on a virtual interface that is attached to a direct connect gateway.

          • Detached: The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface stops.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

      • nextToken — (String)

        Token to retrieve the next page of the result.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeDirectConnectGateways(params = {}, callback) ⇒ AWS.Request

Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned.

Service Reference:

Examples:

Calling the describeDirectConnectGateways operation

var params = {
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
directconnect.describeDirectConnectGateways(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • directConnectGatewayId — (String)

      The ID of the direct connect gateway.

      Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

      Default: None

    • maxResults — (Integer)

      The maximum number of direct connect gateways to return per page.

      Example: 15

      Default: None

    • nextToken — (String)

      The token provided in the previous describe result to retrieve the next page of the result.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • directConnectGateways — (Array<map>)

        Information about the direct connect gateways.

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • directConnectGatewayName — (String)

          The name of the direct connect gateway.

          Example: "My direct connect gateway"

          Default: None

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • ownerAccount — (String)

          The AWS account ID of the owner of the direct connect gateway.

        • directConnectGatewayState — (String)

          State of the direct connect gateway.

          • Pending: The initial state after calling CreateDirectConnectGateway.

          • Available: The direct connect gateway is ready for use.

          • Deleting: The initial state after calling DeleteDirectConnectGateway.

          • Deleted: The direct connect gateway is deleted and cannot pass traffic.

          Possible values include:
          • "pending"
          • "available"
          • "deleting"
          • "deleted"
        • stateChangeError — (String)

          Error message when the state of an object fails to advance.

      • nextToken — (String)

        Token to retrieve the next page of the result.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeHostedConnections(params = {}, callback) ⇒ AWS.Request

Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).

Note: This is intended for use by AWS Direct Connect partners only.

Service Reference:

Examples:

Calling the describeHostedConnections operation

var params = {
  connectionId: 'STRING_VALUE' /* required */
};
directconnect.describeHostedConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the interconnect or LAG on which the hosted connections are provisioned.

      Example: dxcon-abc123 or dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connections — (Array<map>)

        A list of connections.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeInterconnectLoa(params = {}, callback) ⇒ AWS.Request

Deprecated in favor of DescribeLoa.

Returns the LOA-CFA for an Interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

Service Reference:

Examples:

Calling the describeInterconnectLoa operation

var params = {
  interconnectId: 'STRING_VALUE', /* required */
  loaContentType: application/pdf,
  providerName: 'STRING_VALUE'
};
directconnect.describeInterconnectLoa(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • interconnectId — (String)

      The ID of the interconnect.

      Example: dxcon-abc123

    • providerName — (String)

      The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

      Default: None

    • loaContentType — (String)

      A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

      Default: application/pdf

      Possible values include:
      • "application/pdf"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • loa — (map)

        A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

        • loaContent — (Buffer, Typed Array, Blob, String)

          The binary contents of the LOA-CFA document.

        • loaContentType — (String)

          A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

          Default: application/pdf

          Possible values include:
          • "application/pdf"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeInterconnects(params = {}, callback) ⇒ AWS.Request

Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

Service Reference:

Examples:

Calling the describeInterconnects operation

var params = {
  interconnectId: 'STRING_VALUE'
};
directconnect.describeInterconnects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • interconnectId — (String)

      The ID of the interconnect.

      Example: dxcon-abc123

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • interconnects — (Array<map>)

        A list of interconnects.

        • interconnectId — (String)

          The ID of the interconnect.

          Example: dxcon-abc123

        • interconnectName — (String)

          The name of the interconnect.

          Example: "1G Interconnect to AWS"

        • interconnectState — (String)

          State of the interconnect.

          • Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The interconnect has been approved, and is being initialized.

          • Available: The network link is up, and the interconnect is ready for use.

          • Down: The network link is down.

          • Deleting: The interconnect is in the process of being deleted.

          • Deleted: The interconnect has been deleted.

          Possible values include:
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps

          Default: None

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLags(params = {}, callback) ⇒ AWS.Request

Describes the link aggregation groups (LAGs) in your account.

If a LAG ID is provided, only information about the specified LAG is returned.

Service Reference:

Examples:

Calling the describeLags operation

var params = {
  lagId: 'STRING_VALUE'
};
directconnect.describeLags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • lagId — (String)

      The ID of the LAG.

      Example: dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • lags — (Array<map>)

        A list of LAGs.

        • connectionsBandwidth — (String)

          The individual bandwidth of the physical connections bundled by the LAG.

          Available values: 1Gbps, 10Gbps

        • numberOfConnections — (Integer)

          The number of physical connections bundled by the LAG, up to a maximum of 10.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • ownerAccount — (String)

          The owner of the LAG.

        • lagName — (String)

          The name of the LAG.

        • lagState — (String)

          The state of the LAG.

          • Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

          • Pending: The LAG has been approved, and is being initialized.

          • Available: The network link is established, and the LAG is ready for use.

          • Down: The network link is down.

          • Deleting: The LAG is in the process of being deleted.

          • Deleted: The LAG has been deleted.

          Possible values include:
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • minimumLinks — (Integer)

          The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

        • awsDevice — (String)

          The AWS Direct Connection endpoint that hosts the LAG.

        • connections — (Array<map>)

          A list of connections bundled by this LAG.

          • ownerAccount — (String)

            The AWS account that will own the new connection.

          • connectionId — (String)

            The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

            Example: dxcon-fg5678gh

            Default: None

          • connectionName — (String)

            The name of the connection.

            Example: "My Connection to AWS"

            Default: None

          • connectionState — (String)

            State of the connection.

            • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

            • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

            • Pending: The connection has been approved, and is being initialized.

            • Available: The network link is up, and the connection is ready for use.

            • Down: The network link is down.

            • Deleting: The connection is in the process of being deleted.

            • Deleted: The connection has been deleted.

            • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

            Possible values include:
            • "ordering"
            • "requested"
            • "pending"
            • "available"
            • "down"
            • "deleting"
            • "deleted"
            • "rejected"
          • region — (String)

            The AWS region where the connection is located.

            Example: us-east-1

            Default: None

          • location — (String)

            Where the connection is located.

            Example: EqSV5

            Default: None

          • bandwidth — (String)

            Bandwidth of the connection.

            Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

            Default: None

          • vlan — (Integer)

            The VLAN ID.

            Example: 101

          • partnerName — (String)

            The name of the AWS Direct Connect service provider associated with the connection.

          • loaIssueTime — (Date)

            The time of the most recent call to DescribeLoa for this connection.

          • lagId — (String)

            The ID of the LAG.

            Example: dxlag-fg5678gh

          • awsDevice — (String)

            The Direct Connection endpoint which the physical connection terminates on.

        • allowsHostedConnections — (Boolean)

          Indicates whether the LAG can host other connections.

          Note: This is intended for use by AWS Direct Connect partners only.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLoa(params = {}, callback) ⇒ AWS.Request

Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

Service Reference:

Examples:

Calling the describeLoa operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  loaContentType: application/pdf,
  providerName: 'STRING_VALUE'
};
directconnect.describeLoa(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of a connection, LAG, or interconnect for which to get the LOA-CFA information.

      Example: dxcon-abc123 or dxlag-abc123

      Default: None

    • providerName — (String)

      The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

      Default: None

    • loaContentType — (String)

      A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

      Default: application/pdf

      Possible values include:
      • "application/pdf"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • loaContent — (Buffer, Typed Array, Blob, String)

        The binary contents of the LOA-CFA document.

      • loaContentType — (String)

        A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is "application/pdf".

        Default: application/pdf

        Possible values include:
        • "application/pdf"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLocations(params = {}, callback) ⇒ AWS.Request

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.

Service Reference:

Examples:

Calling the describeLocations operation

directconnect.describeLocations(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • locations — (Array<map>)

        A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.

        • locationCode — (String)

          The code used to indicate the AWS Direct Connect location.

        • locationName — (String)

          The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTags(params = {}, callback) ⇒ AWS.Request

Describes the tags associated with the specified Direct Connect resources.

Service Reference:

Examples:

Calling the describeTags operation

var params = {
  resourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
directconnect.describeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArns — (Array<String>)

      The Amazon Resource Names (ARNs) of the Direct Connect resources.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourceTags — (Array<map>)

        Information about the tags.

        • resourceArn — (String)

          The Amazon Resource Name (ARN) of the Direct Connect resource.

        • tags — (Array<map>)

          The tags.

          • keyrequired — (String)

            The key of the tag.

          • value — (String)

            The value of the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeVirtualGateways(params = {}, callback) ⇒ AWS.Request

Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Service Reference:

Examples:

Calling the describeVirtualGateways operation

directconnect.describeVirtualGateways(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualGateways — (Array<map>)

        A list of virtual private gateways.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • virtualGatewayState — (String)

          State of the virtual private gateway.

          • Pending: This is the initial state after calling CreateVpnGateway.

          • Available: Ready for use by a private virtual interface.

          • Deleting: This is the initial state after calling DeleteVpnGateway.

          • Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeVirtualInterfaces(params = {}, callback) ⇒ AWS.Request

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

Service Reference:

Examples:

Calling the describeVirtualInterfaces operation

var params = {
  connectionId: 'STRING_VALUE',
  virtualInterfaceId: 'STRING_VALUE'
};
directconnect.describeVirtualInterfaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

      Example: dxcon-fg5678gh

      Default: None

    • virtualInterfaceId — (String)

      The ID of the virtual interface.

      Example: dxvif-123dfg56

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • virtualInterfaces — (Array<map>)

        A list of virtual interfaces.

        • ownerAccount — (String)

          The AWS account that will own the new virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

          Example: dxvif-123dfg56

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • virtualInterfaceType — (String)

          The type of virtual interface.

          Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer.

          Example: "My VPC"

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • asn — (Integer)

          The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

          Example: 65000

        • amazonSideAsn — (Integer)

          The autonomous system number (ASN) for the Amazon side of the connection.

        • authKey — (String)

          The authentication key for BGP configuration.

          Example: asdf34example

        • amazonAddress — (String)

          IP address assigned to the Amazon interface.

          Example: 192.168.1.1/30 or 2001:db8::1/125

        • customerAddress — (String)

          IP address assigned to the customer interface.

          Example: 192.168.1.2/30 or 2001:db8::2/125

        • addressFamily — (String)

          Indicates the address family for the BGP peer.

          • ipv4: IPv4 address family

          • ipv6: IPv6 address family

          Possible values include:
          • "ipv4"
          • "ipv6"
        • virtualInterfaceState — (String)

          State of the virtual interface.

          • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

          • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

          • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

          • Available: A virtual interface that is able to forward traffic.

          • Down: A virtual interface that is BGP down.

          • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

          • Deleted: A virtual interface that cannot forward traffic.

          • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

          Possible values include:
          • "confirming"
          • "verifying"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • customerRouterConfig — (String)

          Information for generating the customer router configuration.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

          Example: vgw-123er56

        • directConnectGatewayId — (String)

          The ID of the direct connect gateway.

          Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

        • routeFilterPrefixes — (Array<map>)

          A list of routes to be advertised to the AWS network in this region (public virtual interface).

          • cidr — (String)

            CIDR notation for the advertised route. Multiple routes are separated by commas.

            IPv6 CIDRs must be at least a /64 or shorter

            Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

        • bgpPeers — (Array<map>)

          A list of the BGP peers configured on this virtual interface.

          • asn — (Integer)

            The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

            Example: 65000

          • authKey — (String)

            The authentication key for BGP configuration.

            Example: asdf34example

          • addressFamily — (String)

            Indicates the address family for the BGP peer.

            • ipv4: IPv4 address family

            • ipv6: IPv6 address family

            Possible values include:
            • "ipv4"
            • "ipv6"
          • amazonAddress — (String)

            IP address assigned to the Amazon interface.

            Example: 192.168.1.1/30 or 2001:db8::1/125

          • customerAddress — (String)

            IP address assigned to the customer interface.

            Example: 192.168.1.2/30 or 2001:db8::2/125

          • bgpPeerState — (String)

            The state of the BGP peer.

            • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

            • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

            • Available: The BGP peer can be established.

            • Deleting: The BGP peer is in the process of being deleted.

            • Deleted: The BGP peer has been deleted and cannot be established.

            Possible values include:
            • "verifying"
            • "pending"
            • "available"
            • "deleting"
            • "deleted"
          • bgpStatus — (String)

            The Up/Down state of the BGP peer.

            • Up: The BGP peer is established.

            • Down: The BGP peer is down.

            Possible values include:
            • "up"
            • "down"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateConnectionFromLag(params = {}, callback) ⇒ AWS.Request

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect partner is automatically converted to an interconnect.

If disassociating the connection will cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

Service Reference:

Examples:

Calling the disassociateConnectionFromLag operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  lagId: 'STRING_VALUE' /* required */
};
directconnect.disassociateConnectionFromLag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectionId — (String)

      The ID of the connection to disassociate from the LAG.

      Example: dxcon-abc123

      Default: None

    • lagId — (String)

      The ID of the LAG.

      Example: dxlag-abc123

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ownerAccount — (String)

        The AWS account that will own the new connection.

      • connectionId — (String)

        The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

        Example: dxcon-fg5678gh

        Default: None

      • connectionName — (String)

        The name of the connection.

        Example: "My Connection to AWS"

        Default: None

      • connectionState — (String)

        State of the connection.

        • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

        • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

        • Pending: The connection has been approved, and is being initialized.

        • Available: The network link is up, and the connection is ready for use.

        • Down: The network link is down.

        • Deleting: The connection is in the process of being deleted.

        • Deleted: The connection has been deleted.

        • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

        Possible values include:
        • "ordering"
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
        • "rejected"
      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • bandwidth — (String)

        Bandwidth of the connection.

        Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

        Default: None

      • vlan — (Integer)

        The VLAN ID.

        Example: 101

      • partnerName — (String)

        The name of the AWS Direct Connect service provider associated with the connection.

      • loaIssueTime — (Date)

        The time of the most recent call to DescribeLoa for this connection.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • awsDevice — (String)

        The Direct Connection endpoint which the physical connection terminates on.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds the specified tags to the specified Direct Connect resource. Each Direct Connect resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the Direct Connect resource, this action updates its value.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
directconnect.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the Direct Connect resource.

      Example: arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-fg5678gh

    • tags — (Array<map>)

      The list of tags to add.

      • keyrequired — (String)

        The key of the tag.

      • value — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from the specified Direct Connect resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
directconnect.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the Direct Connect resource.

    • tagKeys — (Array<String>)

      The list of tag keys to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateLag(params = {}, callback) ⇒ AWS.Request

Updates the attributes of a link aggregation group (LAG).

You can update the following attributes:

  • The name of the LAG.

  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value, and the number of operational connections falls below the specified value, the LAG will automatically go down to avoid overutilization of the remaining connections. Adjusting this value should be done with care as it could force the LAG down if the value is set higher than the current number of operational connections.

Service Reference:

Examples:

Calling the updateLag operation

var params = {
  lagId: 'STRING_VALUE', /* required */
  lagName: 'STRING_VALUE',
  minimumLinks: 0
};
directconnect.updateLag(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • lagId — (String)

      The ID of the LAG to update.

      Example: dxlag-abc123

      Default: None

    • lagName — (String)

      The name for the LAG.

      Example: "3x10G LAG to AWS"

      Default: None

    • minimumLinks — (Integer)

      The minimum number of physical connections that must be operational for the LAG itself to be operational.

      Default: None

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectionsBandwidth — (String)

        The individual bandwidth of the physical connections bundled by the LAG.

        Available values: 1Gbps, 10Gbps

      • numberOfConnections — (Integer)

        The number of physical connections bundled by the LAG, up to a maximum of 10.

      • lagId — (String)

        The ID of the LAG.

        Example: dxlag-fg5678gh

      • ownerAccount — (String)

        The owner of the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG.

        • Requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

        • Pending: The LAG has been approved, and is being initialized.

        • Available: The network link is established, and the LAG is ready for use.

        • Down: The network link is down.

        • Deleting: The LAG is in the process of being deleted.

        • Deleted: The LAG has been deleted.

        Possible values include:
        • "requested"
        • "pending"
        • "available"
        • "down"
        • "deleting"
        • "deleted"
      • location — (String)

        Where the connection is located.

        Example: EqSV5

        Default: None

      • region — (String)

        The AWS region where the connection is located.

        Example: us-east-1

        Default: None

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

      • awsDevice — (String)

        The AWS Direct Connection endpoint that hosts the LAG.

      • connections — (Array<map>)

        A list of connections bundled by this LAG.

        • ownerAccount — (String)

          The AWS account that will own the new connection.

        • connectionId — (String)

          The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

          Example: dxcon-fg5678gh

          Default: None

        • connectionName — (String)

          The name of the connection.

          Example: "My Connection to AWS"

          Default: None

        • connectionState — (String)

          State of the connection.

          • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

          • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

          • Pending: The connection has been approved, and is being initialized.

          • Available: The network link is up, and the connection is ready for use.

          • Down: The network link is down.

          • Deleting: The connection is in the process of being deleted.

          • Deleted: The connection has been deleted.

          • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

          Possible values include:
          • "ordering"
          • "requested"
          • "pending"
          • "available"
          • "down"
          • "deleting"
          • "deleted"
          • "rejected"
        • region — (String)

          The AWS region where the connection is located.

          Example: us-east-1

          Default: None

        • location — (String)

          Where the connection is located.

          Example: EqSV5

          Default: None

        • bandwidth — (String)

          Bandwidth of the connection.

          Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

          Default: None

        • vlan — (Integer)

          The VLAN ID.

          Example: 101

        • partnerName — (String)

          The name of the AWS Direct Connect service provider associated with the connection.

        • loaIssueTime — (Date)

          The time of the most recent call to DescribeLoa for this connection.

        • lagId — (String)

          The ID of the LAG.

          Example: dxlag-fg5678gh

        • awsDevice — (String)

          The Direct Connection endpoint which the physical connection terminates on.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

        Note: This is intended for use by AWS Direct Connect partners only.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.