The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

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

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services 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 Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services 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|AWS.Endpoint) —

    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' or an Endpoint object.

  • 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. The function is only called for retryable errors.
  • 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|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

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

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.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.

Service Reference:

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 Amazon Web Services 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 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 gateway or transit gateway.

        • directConnectGatewayId — (String)

          The ID of the Direct Connect gateway.

        • directConnectGatewayOwnerAccount — (String)

          The ID of the Amazon Web Services 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.

          • updating: The CIDR blocks for the virtual private gateway or transit gateway are currently being updated. This could be new CIDR blocks added or current CIDR blocks removed.

          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 Amazon Web Services 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 Amazon Web Services Region where the virtual private gateway is located.

        • virtualGatewayOwnerAccount — (String)

          The ID of the Amazon Web Services 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

Note: 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 Direct Connect Partners only.

Service Reference:

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 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 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 are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint that terminates the physical connection.

      • awsLogicalDeviceId — (String)

        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

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

        • key — required — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

      • macSecCapable — (Boolean)

        Indicates whether the connection supports MAC Security (MACsec).

      • portEncryptionStatus — (String)

        The MAC Security (MACsec) port link status of the connection.

        The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

      • encryptionMode — (String)

        The MAC Security (MACsec) connection encryption mode.

        The valid values are no_encrypt, should_encrypt, and must_encrypt.

      • macSecKeys — (Array<map>)

        The MAC Security (MACsec) security keys associated with the connection.

        • secretARN — (String)

          The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

        • ckn — (String)

          The Connection Key Name (CKN) for the MAC Security secret key.

        • state — (String)

          The state of the MAC Security (MACsec) secret key.

          The possible values are:

          • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.

          • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.

          • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG

          • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

        • startOn — (String)

          The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

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. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Note: Intended for use by 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 Amazon Web Services 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, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps 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.

      • key — required — (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 Amazon Web Services 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 Amazon Web Services 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 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 are supported.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint that terminates the physical connection.

      • awsLogicalDeviceId — (String)

        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

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

        • key — required — (String)

          The key.

        • value — (String)

          The value.

      • providerName — (String)

        The name of the service provider associated with the connection.

      • macSecCapable — (Boolean)

        Indicates whether the connection supports MAC Security (MACsec).

      • portEncryptionStatus — (String)

        The MAC Security (MACsec) port link status of the connection.

        The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

      • encryptionMode — (String)

        The MAC Security (MACsec) connection encryption mode.

        The valid values are no_encrypt, should_encrypt, and must_encrypt.

      • macSecKeys — (Array<map>)

        The MAC Security (MACsec) security keys associated with the connection.

        • secretARN — (String)

          The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

        • ckn — (String)

          The Connection Key Name (CKN) for the MAC Security secret key.

        • state — (String)

          The state of the MAC Security (MACsec) secret key.

          The possible values are:

          • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.

          • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.

          • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG

          • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

        • startOn — (String)

          The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

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 Amazon Web Services 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 Amazon Web Services account that owns the virtual private interface.

    • newPrivateVirtualInterfaceAllocation — (map)

      Information about the private virtual interface.

      • virtualInterfaceName — required — (String)

        The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

      • vlan — required — (Integer)

        The ID of the VLAN.

      • asn — required — (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 8500. 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.

        • key — required — (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 Amazon Web Services 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, public and transit.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

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

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames 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 Amazon Web Services 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 that terminates the BGP peer.

        • awsLogicalDeviceId — (String)

          The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      • region — (String)

        The Amazon Web Services Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint that terminates the physical connection.

      • awsLogicalDeviceId — (String)

        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • key — required — (String)

          The key.

        • value — (String)

          The value.

      • siteLinkEnabled — (Boolean)

        Indicates whether SiteLink is enabled.

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 Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services 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 Amazon Web Services account that owns the public virtual interface.

    • newPublicVirtualInterfaceAllocation — (map)

      Information about the public virtual interface.

      • virtualInterfaceName — required — (String)

        The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

      • vlan — required — (Integer)

        The ID of the VLAN.

      • asn — required — (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 Amazon Web Services 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.

        • key — required — (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 Amazon Web Services 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, public and transit.

      • virtualInterfaceName — (String)

        The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

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

      • jumboFrameCapable — (Boolean)

        Indicates whether jumbo frames 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 Amazon Web Services 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 that terminates the BGP peer.

        • awsLogicalDeviceId — (String)

          The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      • region — (String)

        The Amazon Web Services Region where the virtual interface is located.

      • awsDeviceV2 — (String)

        The Direct Connect endpoint that terminates the physical connection.

      • awsLogicalDeviceId — (String)

        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      • tags — (Array<map>)

        The tags associated with the virtual interface.

        • key — required — (String)

          The key.

        • value — (String)

          The value.

      • siteLinkEnabled — (Boolean)

        Indicates whether SiteLink is enabled.

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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

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

        • key — required — (String)

          The key.