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.

Service Description

AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locations associated with those Regions.

Sending a Request Using DirectConnect

var directconnect = new AWS.DirectConnect();
directconnect.acceptDirectConnectGatewayAssociationProposal(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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. 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.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

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

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

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

Examples:

Calling the acceptDirectConnectGatewayAssociationProposal operation

var params = {
  associatedGatewayOwnerAccount: 'STRING_VALUE', /* required */
  directConnectGatewayId: 'STRING_VALUE', /* required */
  proposalId: 'STRING_VALUE', /* required */
  overrideAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
directconnect.acceptDirectConnectGatewayAssociationProposal(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.

    • proposalId — (String)

      The ID of the request proposal.

    • associatedGatewayOwnerAccount — (String)

      The ID of the AWS account that owns the virtual private gateway or transit gateway.

    • overrideAllowedPrefixesToDirectConnectGateway — (Array<map>)

      Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

      For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

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)

        Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the associated gateway.

        • associationState — (String)

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

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

          The error message if the state of an object failed to advance.

        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • associationId — (String)

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion — (String)

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the virtual private gateway.

Returns:

  • (AWS.Request)

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

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

Deprecated. Use AllocateHostedConnection instead.

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

Note: 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: 'NUMBER_VALUE' /* 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)

      The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

    • connectionName — (String)

      The name of the provisioned connection.

    • ownerAccount — (String)

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

    • interconnectId — (String)

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

    • vlan — (Integer)

      The dedicated VLAN provisioned to the connection.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.

Note: 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: 'NUMBER_VALUE', /* required */
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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.

    • ownerAccount — (String)

      The ID of the AWS account ID of the customer for the connection.

    • bandwidth — (String)

      The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

    • connectionName — (String)

      The name of the hosted connection.

    • vlan — (Integer)

      The dedicated VLAN provisioned to the hosted connection.

    • tags — (Array<map>)

      The tags associated with the connection.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

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 the specified AWS account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

Service Reference:

Examples:

Calling the allocatePrivateVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPrivateVirtualInterfaceAllocation: { /* required */
    asn: 'NUMBER_VALUE', /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 'NUMBER_VALUE', /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    mtu: 'NUMBER_VALUE',
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  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 ID of the connection on which the private virtual interface is provisioned.

    • ownerAccount — (String)

      The ID of the AWS account that owns the virtual private interface.

    • newPrivateVirtualInterfaceAllocation — (map)

      Information about the private virtual interface.

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer network.

      • vlanrequired — (Integer)

        The ID of the VLAN.

      • asnrequired — (Integer)

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

        The valid values are 1-2147483647.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The IP address assigned to the customer interface.

      • tags — (Array<map>)

        The tags associated with the private virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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 the specified AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Service Reference:

Examples:

Calling the allocatePublicVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPublicVirtualInterfaceAllocation: { /* required */
    asn: 'NUMBER_VALUE', /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 'NUMBER_VALUE', /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    routeFilterPrefixes: [
      {
        cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: '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 ID of the connection on which the public virtual interface is provisioned.

    • ownerAccount — (String)

      The ID of the AWS account that owns the public virtual interface.

    • newPublicVirtualInterfaceAllocation — (map)

      Information about the public virtual interface.

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer network.

      • vlanrequired — (Integer)

        The ID of the VLAN.

      • asnrequired — (Integer)

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

        The valid values are 1-2147483647.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • tags — (Array<map>)

        The tags associated with the public virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

Returns:

  • (AWS.Request)

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

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

Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Service Reference:

Examples:

Calling the allocateTransitVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newTransitVirtualInterfaceAllocation: { /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    asn: 'NUMBER_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    mtu: 'NUMBER_VALUE',
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    virtualInterfaceName: 'STRING_VALUE',
    vlan: 'NUMBER_VALUE'
  },
  ownerAccount: 'STRING_VALUE' /* required */
};
directconnect.allocateTransitVirtualInterface(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 on which the transit virtual interface is provisioned.

    • ownerAccount — (String)

      The ID of the AWS account that owns the transit virtual interface.

    • newTransitVirtualInterfaceAllocation — (map)

      Information about the transit virtual interface.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The tags associated with the transitive virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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)

        Information about a virtual interface.

        • ownerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • location — (String)

          The location of the connection.

        • connectionId — (String)

          The ID of the connection.

        • virtualInterfaceType — (String)

          The type of virtual interface. The possible values are private and public.

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer network.

        • vlan — (Integer)

          The ID of the VLAN.

        • asn — (Integer)

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

          The valid values are 1-2147483647.

        • amazonSideAsn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • amazonAddress — (String)

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The state of the virtual interface. The following are the possible values:

          • 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 enters the Rejected state.

          • unknown: The state of the virtual interface is not available.

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

          The customer router configuration.

        • mtu — (Integer)

          The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • routeFilterPrefixes — (Array<map>)

          The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • bgpPeers — (Array<map>)

          The BGP peers configured on this virtual interface.

          • bgpPeerId — (String)

            The ID of the BGP peer.

          • asn — (Integer)

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

          • authKey — (String)

            The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

          • addressFamily — (String)

            The address family for the BGP peer.

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

            The IP address assigned to the Amazon interface.

          • customerAddress — (String)

            The IP address assigned to the customer interface.

          • bgpPeerState — (String)

            The state of the BGP peer. The following are the possible values:

            • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

            • pending: The BGP peer is created, and remains in this state until it is ready to be established.

            • available: The BGP peer is ready to be established.

            • deleting: The BGP peer is being deleted.

            • deleted: The BGP peer is deleted and cannot be established.

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

            The status of the BGP peer. The following are the possible values:

            • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • down: The BGP peer is down.

            • unknown: The BGP peer status is not available.

            Possible values include:
            • "up"
            • "down"
            • "unknown"
          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the BGP peer terminates.

        • region — (String)

          The AWS Region where the virtual interface is located.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the virtual interface terminates.

        • tags — (Array<map>)

          The tags associated with the virtual interface.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

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 is 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 re-associate a connection that's currently associated with a different LAG; however, if removing the connection would 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.

    • lagId — (String)

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

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

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: 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.

    • parentConnectionId — (String)

      The ID of the interconnect or the LAG.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

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.

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 for the association.

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.

    • connectionId — (String)

      The ID of the LAG or connection.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

Returns:

  • (AWS.Request)

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

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

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms 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 hosted connection.

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)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

Returns:

  • (AWS.Request)

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

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

Accepts ownership of a private virtual interface created by another AWS account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle 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.

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

    • directConnectGatewayId — (String)

      The ID of the Direct Connect gateway.

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)

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

Returns:

  • (AWS.Request)

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

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

Accepts ownership of a public virtual interface created by another AWS account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle 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.

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)

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

Returns:

  • (AWS.Request)

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

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

Accepts ownership of a transit virtual interface created by another AWS account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

Service Reference:

Examples:

Calling the confirmTransitVirtualInterface operation

var params = {
  directConnectGatewayId: 'STRING_VALUE', /* required */
  virtualInterfaceId: 'STRING_VALUE' /* required */
};
directconnect.confirmTransitVirtualInterface(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.

    • directConnectGatewayId — (String)

      The ID of the Direct Connect gateway.

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)

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

Returns:

  • (AWS.Request)

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

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

Creates a BGP peer on the specified virtual interface.

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

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon 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: 'NUMBER_VALUE',
    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.

    • newBGPPeer — (map)

      Information about the BGP peer.

      • asn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

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)

        The virtual interface.

        • ownerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • location — (String)

          The location of the connection.

        • connectionId — (String)

          The ID of the connection.

        • virtualInterfaceType — (String)

          The type of virtual interface. The possible values are private and public.

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer network.

        • vlan — (Integer)

          The ID of the VLAN.

        • asn — (Integer)

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

          The valid values are 1-2147483647.

        • amazonSideAsn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • amazonAddress — (String)

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The state of the virtual interface. The following are the possible values:

          • 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 enters the Rejected state.

          • unknown: The state of the virtual interface is not available.

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

          The customer router configuration.

        • mtu — (Integer)

          The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • routeFilterPrefixes — (Array<map>)

          The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • bgpPeers — (Array<map>)

          The BGP peers configured on this virtual interface.

          • bgpPeerId — (String)

            The ID of the BGP peer.

          • asn — (Integer)

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

          • authKey — (String)

            The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

          • addressFamily — (String)

            The address family for the BGP peer.

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

            The IP address assigned to the Amazon interface.

          • customerAddress — (String)

            The IP address assigned to the customer interface.

          • bgpPeerState — (String)

            The state of the BGP peer. The following are the possible values:

            • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

            • pending: The BGP peer is created, and remains in this state until it is ready to be established.

            • available: The BGP peer is ready to be established.

            • deleting: The BGP peer is being deleted.

            • deleted: The BGP peer is deleted and cannot be established.

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

            The status of the BGP peer. The following are the possible values:

            • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • down: The BGP peer is down.

            • unknown: The BGP peer status is not available.

            Possible values include:
            • "up"
            • "down"
            • "unknown"
          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the BGP peer terminates.

        • region — (String)

          The AWS Region where the virtual interface is located.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the virtual interface terminates.

        • tags — (Array<map>)

          The tags associated with the virtual interface.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

Returns:

  • (AWS.Request)

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

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

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

A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.

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 is 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',
  providerName: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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)

      The location of the connection.

    • bandwidth — (String)

      The bandwidth of the connection.

    • connectionName — (String)

      The name of the connection.

    • lagId — (String)

      The ID of the LAG.

    • tags — (Array<map>)

      The tags to associate with the lag.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

    • providerName — (String)

      The name of the service provider associated with the requested connection.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS 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: 'NUMBER_VALUE'
};
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.

    • 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. The default is 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.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayName — (String)

          The name of the Direct Connect gateway.

        • amazonSideAsn — (Integer)

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

        • ownerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • directConnectGatewayState — (String)

          The state of the Direct Connect gateway. The following are the possible values:

          • 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)

          The error message if the state of an object failed 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. The virtual private gateway 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 */
  addAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ],
  gatewayId: 'STRING_VALUE',
  virtualGatewayId: 'STRING_VALUE'
};
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.

    • gatewayId — (String)

      The ID of the virtual private gateway or transit gateway.

    • addAllowedPrefixesToDirectConnectGateway — (Array<map>)

      The Amazon VPC prefixes to advertise to the Direct Connect gateway

      This parameter is required when you create an association to a transit gateway.

      For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

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 association to be created.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the associated gateway.

        • associationState — (String)

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

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

          The error message if the state of an object failed to advance.

        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • associationId — (String)

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion — (String)

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the virtual private gateway.

Returns:

  • (AWS.Request)

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

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

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID.

Examples:

Calling the createDirectConnectGatewayAssociationProposal operation

var params = {
  directConnectGatewayId: 'STRING_VALUE', /* required */
  directConnectGatewayOwnerAccount: 'STRING_VALUE', /* required */
  gatewayId: 'STRING_VALUE', /* required */
  addAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ],
  removeAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
directconnect.createDirectConnectGatewayAssociationProposal(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.

    • directConnectGatewayOwnerAccount — (String)

      The ID of the AWS account that owns the Direct Connect gateway.

    • gatewayId — (String)

      The ID of the virtual private gateway or transit gateway.

    • addAllowedPrefixesToDirectConnectGateway — (Array<map>)

      The Amazon VPC prefixes to advertise to the Direct Connect gateway.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

    • removeAllowedPrefixesToDirectConnectGateway — (Array<map>)

      The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

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:

      • directConnectGatewayAssociationProposal — (map)

        Information about the Direct Connect gateway proposal.

        • proposalId — (String)

          The ID of the association proposal.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • proposalState — (String)

          The state of the proposal. The following are possible values:

          • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

          • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

          • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

          Possible values include:
          • "requested"
          • "accepted"
          • "deleted"
        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • existingAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • requestedAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

Returns:

  • (AWS.Request)

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

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

Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard 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 is created.

For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. 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: 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',
  providerName: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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.

    • bandwidth — (String)

      The port bandwidth, in Gbps. The possible values are 1 and 10.

    • location — (String)

      The location of the interconnect.

    • lagId — (String)

      The ID of the LAG.

    • tags — (Array<map>)

      The tags to associate with the interconnect.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

    • providerName — (String)

      The name of the service provider associated with the interconnect.

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.

      • interconnectName — (String)

        The name of the interconnect.

      • interconnectState — (String)

        The state of the interconnect. The following are the possible values:

        • 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 is 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 being deleted.

        • deleted: The interconnect is deleted.

        • unknown: The state of the interconnect is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • loaIssueTime — (Date)

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

      • lagId — (String)

        The ID of the LAG.

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the interconnect.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the interconnect.

Returns:

  • (AWS.Request)

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

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

Creates a 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 interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth 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: 'NUMBER_VALUE', /* required */
  childConnectionTags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ],
  connectionId: 'STRING_VALUE',
  providerName: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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.

    • location — (String)

      The location for the LAG.

    • connectionsBandwidth — (String)

      The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.

    • lagName — (String)

      The name of the LAG.

    • connectionId — (String)

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

    • tags — (Array<map>)

      The tags to associate with the LAG.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

    • childConnectionTags — (Array<map>)

      The tags to associate with the automtically created LAGs.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

    • providerName — (String)

      The name of the service provider associated with the LAG.

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. The possible values are 1Gbps and 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.

      • ownerAccount — (String)

        The ID of the AWS account that owns the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG. The following are the possible values:

        • 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 being deleted.

        • deleted: The LAG is deleted.

        • unknown: The state of the LAG is not available.

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

        The location of the LAG.

      • region — (String)

        The AWS Region where the connection is located.

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational.

      • awsDevice — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • awsDeviceV2 — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • connections — (Array<map>)

        The connections bundled by the LAG.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • hasLogicalRedundancy — (String)

        Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the LAG.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the LAG.

Returns:

  • (AWS.Request)

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

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

Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Service Reference:

Examples:

Calling the createPrivateVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPrivateVirtualInterface: { /* required */
    asn: 'NUMBER_VALUE', /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 'NUMBER_VALUE', /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    directConnectGatewayId: 'STRING_VALUE',
    mtu: 'NUMBER_VALUE',
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    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.

    • newPrivateVirtualInterface — (map)

      Information about the private virtual interface.

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer network.

      • vlanrequired — (Integer)

        The ID of the VLAN.

      • asnrequired — (Integer)

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

        The valid values are 1-2147483647.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The ID of the virtual private gateway.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • tags — (Array<map>)

        The tags associated with the private virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

Returns:

  • (AWS.Request)

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

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

Creates a 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 S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

Service Reference:

Examples:

Calling the createPublicVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newPublicVirtualInterface: { /* required */
    asn: 'NUMBER_VALUE', /* required */
    virtualInterfaceName: 'STRING_VALUE', /* required */
    vlan: 'NUMBER_VALUE', /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    routeFilterPrefixes: [
      {
        cidr: 'STRING_VALUE'
      },
      /* more items */
    ],
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: '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.

    • newPublicVirtualInterface — (map)

      Information about the public virtual interface.

      • virtualInterfaceNamerequired — (String)

        The name of the virtual interface assigned by the customer network.

      • vlanrequired — (Integer)

        The ID of the VLAN.

      • asnrequired — (Integer)

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

        The valid values are 1-2147483647.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • tags — (Array<map>)

        The tags associated with the public virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

Returns:

  • (AWS.Request)

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

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

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

Service Reference:

Examples:

Calling the createTransitVirtualInterface operation

var params = {
  connectionId: 'STRING_VALUE', /* required */
  newTransitVirtualInterface: { /* required */
    addressFamily: ipv4 | ipv6,
    amazonAddress: 'STRING_VALUE',
    asn: 'NUMBER_VALUE',
    authKey: 'STRING_VALUE',
    customerAddress: 'STRING_VALUE',
    directConnectGatewayId: 'STRING_VALUE',
    mtu: 'NUMBER_VALUE',
    tags: [
      {
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    virtualInterfaceName: 'STRING_VALUE',
    vlan: 'NUMBER_VALUE'
  }
};
directconnect.createTransitVirtualInterface(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.

    • newTransitVirtualInterface — (map)

      Information about the transit virtual interface.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The ID of the Direct Connect gateway.

      • tags — (Array<map>)

        The tags associated with the transitive virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

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)

        Information about a virtual interface.

        • ownerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • location — (String)

          The location of the connection.

        • connectionId — (String)

          The ID of the connection.

        • virtualInterfaceType — (String)

          The type of virtual interface. The possible values are private and public.

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer network.

        • vlan — (Integer)

          The ID of the VLAN.

        • asn — (Integer)

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

          The valid values are 1-2147483647.

        • amazonSideAsn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • amazonAddress — (String)

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The state of the virtual interface. The following are the possible values:

          • 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 enters the Rejected state.

          • unknown: The state of the virtual interface is not available.

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

          The customer router configuration.

        • mtu — (Integer)

          The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • routeFilterPrefixes — (Array<map>)

          The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • bgpPeers — (Array<map>)

          The BGP peers configured on this virtual interface.

          • bgpPeerId — (String)

            The ID of the BGP peer.

          • asn — (Integer)

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

          • authKey — (String)

            The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

          • addressFamily — (String)

            The address family for the BGP peer.

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

            The IP address assigned to the Amazon interface.

          • customerAddress — (String)

            The IP address assigned to the customer interface.

          • bgpPeerState — (String)

            The state of the BGP peer. The following are the possible values:

            • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

            • pending: The BGP peer is created, and remains in this state until it is ready to be established.

            • available: The BGP peer is ready to be established.

            • deleting: The BGP peer is being deleted.

            • deleted: The BGP peer is deleted and cannot be established.

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

            The status of the BGP peer. The following are the possible values:

            • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • down: The BGP peer is down.

            • unknown: The BGP peer status is not available.

            Possible values include:
            • "up"
            • "down"
            • "unknown"
          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the BGP peer terminates.

        • region — (String)

          The AWS Region where the virtual interface is located.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the virtual interface terminates.

        • tags — (Array<map>)

          The tags associated with the virtual interface.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

Returns:

  • (AWS.Request)

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

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

Deletes the specified BGP peer on the specified virtual interface with 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: 'NUMBER_VALUE',
  bgpPeerId: 'STRING_VALUE',
  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.

    • asn — (Integer)

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

    • customerAddress — (String)

      The IP address assigned to the customer interface.

    • bgpPeerId — (String)

      The ID of the BGP peer.

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)

        The virtual interface.

        • ownerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • location — (String)

          The location of the connection.

        • connectionId — (String)

          The ID of the connection.

        • virtualInterfaceType — (String)

          The type of virtual interface. The possible values are private and public.

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer network.

        • vlan — (Integer)

          The ID of the VLAN.

        • asn — (Integer)

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

          The valid values are 1-2147483647.

        • amazonSideAsn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • amazonAddress — (String)

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The state of the virtual interface. The following are the possible values:

          • 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 enters the Rejected state.

          • unknown: The state of the virtual interface is not available.

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

          The customer router configuration.

        • mtu — (Integer)

          The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • routeFilterPrefixes — (Array<map>)

          The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • bgpPeers — (Array<map>)

          The BGP peers configured on this virtual interface.

          • bgpPeerId — (String)

            The ID of the BGP peer.

          • asn — (Integer)

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

          • authKey — (String)

            The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

          • addressFamily — (String)

            The address family for the BGP peer.

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

            The IP address assigned to the Amazon interface.

          • customerAddress — (String)

            The IP address assigned to the customer interface.

          • bgpPeerState — (String)

            The state of the BGP peer. The following are the possible values:

            • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

            • pending: The BGP peer is created, and remains in this state until it is ready to be established.

            • available: The BGP peer is ready to be established.

            • deleting: The BGP peer is being deleted.

            • deleted: The BGP peer is deleted and cannot be established.

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

            The status of the BGP peer. The following are the possible values:

            • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • down: The BGP peer is down.

            • unknown: The BGP peer status is not available.

            Possible values include:
            • "up"
            • "down"
            • "unknown"
          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the BGP peer terminates.

        • region — (String)

          The AWS Region where the virtual interface is located.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the virtual interface terminates.

        • tags — (Array<map>)

          The tags associated with the virtual interface.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

Returns:

  • (AWS.Request)

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

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

Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.

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.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways 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.

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.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayName — (String)

          The name of the Direct Connect gateway.

        • amazonSideAsn — (Integer)

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

        • ownerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • directConnectGatewayState — (String)

          The state of the Direct Connect gateway. The following are the possible values:

          • 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)

          The error message if the state of an object failed 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 the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

Examples:

Calling the deleteDirectConnectGatewayAssociation operation

var params = {
  associationId: 'STRING_VALUE',
  directConnectGatewayId: 'STRING_VALUE',
  virtualGatewayId: 'STRING_VALUE'
};
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: {})
    • associationId — (String)

      The ID of the Direct Connect gateway association.

    • directConnectGatewayId — (String)

      The ID of the Direct Connect gateway.

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

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)

        Information about the deleted association.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the associated gateway.

        • associationState — (String)

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

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

          The error message if the state of an object failed to advance.

        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • associationId — (String)

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion — (String)

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the virtual private gateway.

Returns:

  • (AWS.Request)

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

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

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

Examples:

Calling the deleteDirectConnectGatewayAssociationProposal operation

var params = {
  proposalId: 'STRING_VALUE' /* required */
};
directconnect.deleteDirectConnectGatewayAssociationProposal(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: {})
    • proposalId — (String)

      The ID of the proposal.

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:

      • directConnectGatewayAssociationProposal — (map)

        The ID of the associated gateway.

        • proposalId — (String)

          The ID of the association proposal.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • proposalState — (String)

          The state of the proposal. The following are possible values:

          • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

          • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

          • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

          Possible values include:
          • "requested"
          • "accepted"
          • "deleted"
        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • existingAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • requestedAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

Returns:

  • (AWS.Request)

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

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

Deletes the specified interconnect.

Note: 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.

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)

        The state of the interconnect. The following are the possible values:

        • 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 is 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 being deleted.

        • deleted: The interconnect is deleted.

        • unknown: The state of the interconnect is not available.

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

Returns:

  • (AWS.Request)

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

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

Deletes the specified 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.

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. The possible values are 1Gbps and 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.

      • ownerAccount — (String)

        The ID of the AWS account that owns the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG. The following are the possible values:

        • 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 being deleted.

        • deleted: The LAG is deleted.

        • unknown: The state of the LAG is not available.

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

        The location of the LAG.

      • region — (String)

        The AWS Region where the connection is located.

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational.

      • awsDevice — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • awsDeviceV2 — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • connections — (Array<map>)

        The connections bundled by the LAG.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • hasLogicalRedundancy — (String)

        Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the LAG.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the LAG.

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.

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)

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

Returns:

  • (AWS.Request)

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

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

Deprecated. Use DescribeLoa instead.

Gets 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.

    • providerName — (String)

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

    • loaContentType — (String)

      The standard media type for the LOA-CFA document. The only supported value is 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)

        The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

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

          The binary contents of the LOA-CFA document.

        • loaContentType — (String)

          The standard media type for the LOA-CFA document. The only supported value is 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 the specified connection or all connections in this Region.

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.

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>)

        The connections.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Note: 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)

      The ID of the interconnect.

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>)

        The connections.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Examples:

Calling the describeDirectConnectGatewayAssociationProposals operation

var params = {
  associatedGatewayId: 'STRING_VALUE',
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  proposalId: 'STRING_VALUE'
};
directconnect.describeDirectConnectGatewayAssociationProposals(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.

    • proposalId — (String)

      The ID of the proposal.

    • associatedGatewayId — (String)

      The ID of the associated gateway.

    • maxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      If MaxResults is given a value larger than 100, only 100 results are returned.

    • nextToken — (String)

      The token for the next page of results.

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:

      • directConnectGatewayAssociationProposals — (Array<map>)

        Describes the Direct Connect gateway association proposals.

        • proposalId — (String)

          The ID of the association proposal.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • proposalState — (String)

          The state of the proposal. The following are possible values:

          • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

          • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

          • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

          Possible values include:
          • "requested"
          • "accepted"
          • "deleted"
        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • existingAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • requestedAllowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • nextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

Examples:

Calling the describeDirectConnectGatewayAssociations operation

var params = {
  associatedGatewayId: 'STRING_VALUE',
  associationId: 'STRING_VALUE',
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  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: {})
    • associationId — (String)

      The ID of the Direct Connect gateway association.

    • associatedGatewayId — (String)

      The ID of the associated gateway.

    • directConnectGatewayId — (String)

      The ID of the Direct Connect gateway.

    • maxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      If MaxResults is given a value larger than 100, only 100 results are returned.

    • nextToken — (String)

      The token provided in the previous call to retrieve the next page.

    • virtualGatewayId — (String)

      The ID of the virtual private gateway.

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 associations.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the associated gateway.

        • associationState — (String)

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

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

          The error message if the state of an object failed to advance.

        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • associationId — (String)

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion — (String)

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the virtual private gateway.

      • nextToken — (String)

        The token to retrieve the next page.

Returns:

  • (AWS.Request)

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

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

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

Examples:

Calling the describeDirectConnectGatewayAttachments operation

var params = {
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  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.

    • virtualInterfaceId — (String)

      The ID of the virtual interface.

    • maxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      If MaxResults is given a value larger than 100, only 100 results are returned.

    • nextToken — (String)

      The token provided in the previous call to retrieve the next page.

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>)

        The attachments.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • virtualInterfaceRegion — (String)

          The AWS Region where the virtual interface is located.

        • virtualInterfaceOwnerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • attachmentState — (String)

          The state of the attachment. The following are the possible values:

          • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

          • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

          • detaching: The initial state after calling DeleteVirtualInterface.

          • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

          Possible values include:
          • "attaching"
          • "attached"
          • "detaching"
          • "detached"
        • attachmentType — (String)

          The type of attachment.

          Possible values include:
          • "TransitVirtualInterface"
          • "PrivateVirtualInterface"
        • stateChangeError — (String)

          The error message if the state of an object failed to advance.

      • nextToken — (String)

        The token to retrieve the next page.

Returns:

  • (AWS.Request)

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

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

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

Service Reference:

Examples:

Calling the describeDirectConnectGateways operation

var params = {
  directConnectGatewayId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  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.

    • maxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

      If MaxResults is given a value larger than 100, only 100 results are returned.

    • nextToken — (String)

      The token provided in the previous call to retrieve the next page.

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>)

        The Direct Connect gateways.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayName — (String)

          The name of the Direct Connect gateway.

        • amazonSideAsn — (Integer)

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

        • ownerAccount — (String)

          The ID of the AWS account that owns the Direct Connect gateway.

        • directConnectGatewayState — (String)

          The state of the Direct Connect gateway. The following are the possible values:

          • 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)

          The error message if the state of an object failed to advance.

      • nextToken — (String)

        The token to retrieve the next page.

Returns:

  • (AWS.Request)

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

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

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Note: 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.

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>)

        The connections.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

Returns:

  • (AWS.Request)

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

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

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified 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.

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

    • loaContentType — (String)

      The standard media type for the LOA-CFA document. The only supported value is 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)

        The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

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

          The binary contents of the LOA-CFA document.

        • loaContentType — (String)

          The standard media type for the LOA-CFA document. The only supported value is 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

Lists the interconnects owned by the AWS account or only the specified 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.

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>)

        The interconnects.

        • interconnectId — (String)

          The ID of the interconnect.

        • interconnectName — (String)

          The name of the interconnect.

        • interconnectState — (String)

          The state of the interconnect. The following are the possible values:

          • 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 is 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 being deleted.

          • deleted: The interconnect is deleted.

          • unknown: The state of the interconnect is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • loaIssueTime — (Date)

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

        • lagId — (String)

          The ID of the LAG.

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the interconnect.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the interconnect.

Returns:

  • (AWS.Request)

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

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

Describes all your link aggregation groups (LAG) or the specified LAG.

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.

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>)

        The LAGs.

        • connectionsBandwidth — (String)

          The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 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.

        • ownerAccount — (String)

          The ID of the AWS account that owns the LAG.

        • lagName — (String)

          The name of the LAG.

        • lagState — (String)

          The state of the LAG. The following are the possible values:

          • 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 being deleted.

          • deleted: The LAG is deleted.

          • unknown: The state of the LAG is not available.

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

          The location of the LAG.

        • region — (String)

          The AWS Region where the connection is located.

        • minimumLinks — (Integer)

          The minimum number of physical connections that must be operational for the LAG itself to be operational.

        • awsDevice — (String)

          The AWS Direct Connect endpoint that hosts the LAG.

        • awsDeviceV2 — (String)

          The AWS Direct Connect endpoint that hosts the LAG.

        • connections — (Array<map>)

          The connections bundled by the LAG.

          • ownerAccount — (String)

            The ID of the AWS account that owns the connection.

          • connectionId — (String)

            The ID of the connection.

          • connectionName — (String)

            The name of the connection.

          • connectionState — (String)

            The state of the connection. The following are the possible values:

            • 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 being deleted.

            • deleted: The connection has been deleted.

            • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

            • unknown: The state of the connection is not available.

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

            The AWS Region where the connection is located.

          • location — (String)

            The location of the connection.

          • bandwidth — (String)

            The bandwidth of the connection.

          • vlan — (Integer)

            The ID of the VLAN.

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

          • awsDevice — (String)

            The Direct Connect endpoint on which the physical connection terminates.

          • jumboFrameCapable — (Boolean)

            Indicates whether jumbo frames (9001 MTU) are supported.

          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the physical connection terminates.

          • hasLogicalRedundancy — (String)

            Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

            Possible values include:
            • "unknown"
            • "yes"
            • "no"
          • tags — (Array<map>)

            The tags associated with the connection.

            • keyrequired — (String)

              The key.

            • value — (String)

              The value.

          • providerName — (String)

            The name of the service provider associated with the connection.

        • allowsHostedConnections — (Boolean)

          Indicates whether the LAG can host other connections.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • hasLogicalRedundancy — (String)

          Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the LAG.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the LAG.

Returns:

  • (AWS.Request)

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

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

Gets 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.

    • providerName — (String)

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

    • loaContentType — (String)

      The standard media type for the LOA-CFA document. The only supported value is 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(Node.js), Typed Array(Browser))

        The binary contents of the LOA-CFA document.

      • loaContentType — (String)

        The standard media type for the LOA-CFA document. The only supported value is 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

Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can 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>)

        The locations.

        • locationCode — (String)

          The code for the location.

        • locationName — (String)

          The name of the location. This includes the name of the colocation partner and the physical site of the building.

        • region — (String)

          The AWS Region for the location.

        • availablePortSpeeds — (Array<String>)

          The available port speeds for the location.

        • availableProviders — (Array<String>)

          The name of the service provider for the location.

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 AWS 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 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 resource.

        • tags — (Array<map>)

          The tags.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

Returns:

  • (AWS.Request)

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

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

Lists the virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.

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>)

        The virtual private gateways.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway.

        • virtualGatewayState — (String)

          The state of the virtual private gateway. The following are the possible values:

          • pending: Initial state after creating the virtual private gateway.

          • available: Ready for use by a private virtual interface.

          • deleting: Initial state after deleting the virtual private gateway.

          • deleted: The virtual private gateway is deleted. The 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 network.

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.

    • virtualInterfaceId — (String)

      The ID of the virtual interface.

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>)

        The virtual interfaces

        • ownerAccount — (String)

          The ID of the AWS account that owns the virtual interface.

        • virtualInterfaceId — (String)

          The ID of the virtual interface.

        • location — (String)

          The location of the connection.

        • connectionId — (String)

          The ID of the connection.

        • virtualInterfaceType — (String)

          The type of virtual interface. The possible values are private and public.

        • virtualInterfaceName — (String)

          The name of the virtual interface assigned by the customer network.

        • vlan — (Integer)

          The ID of the VLAN.

        • asn — (Integer)

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

          The valid values are 1-2147483647.

        • amazonSideAsn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • amazonAddress — (String)

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The state of the virtual interface. The following are the possible values:

          • 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 enters the Rejected state.

          • unknown: The state of the virtual interface is not available.

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

          The customer router configuration.

        • mtu — (Integer)

          The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • routeFilterPrefixes — (Array<map>)

          The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • bgpPeers — (Array<map>)

          The BGP peers configured on this virtual interface.

          • bgpPeerId — (String)

            The ID of the BGP peer.

          • asn — (Integer)

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

          • authKey — (String)

            The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

          • addressFamily — (String)

            The address family for the BGP peer.

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

            The IP address assigned to the Amazon interface.

          • customerAddress — (String)

            The IP address assigned to the customer interface.

          • bgpPeerState — (String)

            The state of the BGP peer. The following are the possible values:

            • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

            • pending: The BGP peer is created, and remains in this state until it is ready to be established.

            • available: The BGP peer is ready to be established.

            • deleting: The BGP peer is being deleted.

            • deleted: The BGP peer is deleted and cannot be established.

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

            The status of the BGP peer. The following are the possible values:

            • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

            • down: The BGP peer is down.

            • unknown: The BGP peer status is not available.

            Possible values include:
            • "up"
            • "down"
            • "unknown"
          • awsDeviceV2 — (String)

            The Direct Connect endpoint on which the BGP peer terminates.

        • region — (String)

          The AWS Region where the virtual interface is located.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the virtual interface terminates.

        • tags — (Array<map>)

          The tags associated with the virtual interface.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

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 would 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.

    • lagId — (String)

      The ID of the LAG.

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 ID of the AWS account that owns the connection.

      • connectionId — (String)

        The ID of the connection.

      • connectionName — (String)

        The name of the connection.

      • connectionState — (String)

        The state of the connection. The following are the possible values:

        • 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 being deleted.

        • deleted: The connection has been deleted.

        • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

        • unknown: The state of the connection is not available.

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

        The AWS Region where the connection is located.

      • location — (String)

        The location of the connection.

      • bandwidth — (String)

        The bandwidth of the connection.

      • vlan — (Integer)

        The ID of the VLAN.

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

      • awsDevice — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the physical connection terminates.

      • hasLogicalRedundancy — (String)

        Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the connection.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

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 AWS Direct Connect resource. Each 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 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 resource.

    • tags — (Array<map>)

      The tags to add.

      • keyrequired — (String)

        The key.

      • value — (String)

        The value.

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 AWS 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 resource.

    • tagKeys — (Array<String>)

      The tag keys of the tags 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.

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

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

Examples:

Calling the updateDirectConnectGatewayAssociation operation

var params = {
  addAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ],
  associationId: 'STRING_VALUE',
  removeAllowedPrefixesToDirectConnectGateway: [
    {
      cidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
directconnect.updateDirectConnectGatewayAssociation(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: {})
    • associationId — (String)

      The ID of the Direct Connect gateway association.

    • addAllowedPrefixesToDirectConnectGateway — (Array<map>)

      The Amazon VPC prefixes to advertise to the Direct Connect gateway.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

    • removeAllowedPrefixesToDirectConnectGateway — (Array<map>)

      The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

      • cidr — (String)

        The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

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)

        Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the associated gateway.

        • associationState — (String)

          The state of the association. The following are the possible values:

          • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

          • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

          • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

          • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

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

          The error message if the state of an object failed to advance.

        • associatedGateway — (map)

          Information about the associated gateway.

          • id — (String)

            The ID of the associated gateway.

          • type — (String)

            The type of associated gateway.

            Possible values include:
            • "virtualPrivateGateway"
            • "transitGateway"
          • ownerAccount — (String)

            The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

          • region — (String)

            The Region where the associated gateway is located.

        • associationId — (String)

          The ID of the Direct Connect gateway association.

        • allowedPrefixesToDirectConnectGateway — (Array<map>)

          The Amazon VPC prefixes to advertise to the Direct Connect gateway.

          • cidr — (String)

            The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

        • virtualGatewayId — (String)

          The ID of the virtual private gateway. Applies only to private virtual interfaces.

        • virtualGatewayRegion — (String)

          The AWS Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the AWS account that owns the virtual private gateway.

Returns:

  • (AWS.Request)

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

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

Updates the attributes of the specified 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 automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it 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: 'NUMBER_VALUE'
};
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.

    • lagName — (String)

      The name of the LAG.

    • minimumLinks — (Integer)

      The minimum number of physical connections that must be operational for the LAG itself to be operational.

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. The possible values are 1Gbps and 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.

      • ownerAccount — (String)

        The ID of the AWS account that owns the LAG.

      • lagName — (String)

        The name of the LAG.

      • lagState — (String)

        The state of the LAG. The following are the possible values:

        • 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 being deleted.

        • deleted: The LAG is deleted.

        • unknown: The state of the LAG is not available.

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

        The location of the LAG.

      • region — (String)

        The AWS Region where the connection is located.

      • minimumLinks — (Integer)

        The minimum number of physical connections that must be operational for the LAG itself to be operational.

      • awsDevice — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • awsDeviceV2 — (String)

        The AWS Direct Connect endpoint that hosts the LAG.

      • connections — (Array<map>)

        The connections bundled by the LAG.

        • ownerAccount — (String)

          The ID of the AWS account that owns the connection.

        • connectionId — (String)

          The ID of the connection.

        • connectionName — (String)

          The name of the connection.

        • connectionState — (String)

          The state of the connection. The following are the possible values:

          • 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 being deleted.

          • deleted: The connection has been deleted.

          • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

          • unknown: The state of the connection is not available.

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

          The AWS Region where the connection is located.

        • location — (String)

          The location of the connection.

        • bandwidth — (String)

          The bandwidth of the connection.

        • vlan — (Integer)

          The ID of the VLAN.

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

        • awsDevice — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • jumboFrameCapable — (Boolean)

          Indicates whether jumbo frames (9001 MTU) are supported.

        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the physical connection terminates.

        • hasLogicalRedundancy — (String)

          Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

          Possible values include:
          • "unknown"
          • "yes"
          • "no"
        • tags — (Array<map>)

          The tags associated with the connection.

          • keyrequired — (String)

            The key.

          • value — (String)

            The value.

        • providerName — (String)

          The name of the service provider associated with the connection.

      • allowsHostedConnections — (Boolean)

        Indicates whether the LAG can host other connections.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • hasLogicalRedundancy — (String)

        Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

        Possible values include:
        • "unknown"
        • "yes"
        • "no"
      • tags — (Array<map>)

        The tags associated with the LAG.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the LAG.

Returns:

  • (AWS.Request)

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

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

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Examples:

Calling the updateVirtualInterfaceAttributes operation

var params = {
  virtualInterfaceId: 'STRING_VALUE', /* required */
  mtu: 'NUMBER_VALUE'
};
directconnect.updateVirtualInterfaceAttributes(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 private interface.

    • mtu — (Integer)

      The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

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 ID of the AWS account that owns the virtual interface.

      • virtualInterfaceId — (String)

        The ID of the virtual interface.

      • location — (String)

        The location of the connection.

      • connectionId — (String)

        The ID of the connection.

      • virtualInterfaceType — (String)

        The type of virtual interface. The possible values are private and public.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network.

      • vlan — (Integer)

        The ID of the VLAN.

      • asn — (Integer)

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

        The valid values are 1-2147483647.

      • amazonSideAsn — (Integer)

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

      • authKey — (String)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      • amazonAddress — (String)

        The IP address assigned to the Amazon interface.

      • customerAddress — (String)

        The IP address assigned to the customer interface.

      • addressFamily — (String)

        The address family for the BGP peer.

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

        The state of the virtual interface. The following are the possible values:

        • 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 enters the Rejected state.

        • unknown: The state of the virtual interface is not available.

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

        The customer router configuration.

      • mtu — (Integer)

        The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames (9001 MTU) are supported.

      • virtualGatewayId — (String)

        The ID of the virtual private gateway. Applies only to private virtual interfaces.

      • directConnectGatewayId — (String)

        The ID of the Direct Connect gateway.

      • routeFilterPrefixes — (Array<map>)

        The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

        • cidr — (String)

          The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

      • bgpPeers — (Array<map>)

        The BGP peers configured on this virtual interface.

        • bgpPeerId — (String)

          The ID of the BGP peer.

        • asn — (Integer)

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

        • authKey — (String)

          The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        • addressFamily — (String)

          The address family for the BGP peer.

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

          The IP address assigned to the Amazon interface.

        • customerAddress — (String)

          The IP address assigned to the customer interface.

        • bgpPeerState — (String)

          The state of the BGP peer. The following are the possible values:

          • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

          • pending: The BGP peer is created, and remains in this state until it is ready to be established.

          • available: The BGP peer is ready to be established.

          • deleting: The BGP peer is being deleted.

          • deleted: The BGP peer is deleted and cannot be established.

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

          The status of the BGP peer. The following are the possible values:

          • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

          • down: The BGP peer is down.

          • unknown: The BGP peer status is not available.

          Possible values include:
          • "up"
          • "down"
          • "unknown"
        • awsDeviceV2 — (String)

          The Direct Connect endpoint on which the BGP peer terminates.

      • region — (String)

        The AWS Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint on which the virtual interface terminates.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • keyrequired — (String)

          The key.

        • value — (String)

          The value.

Returns:

  • (AWS.Request)

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