Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . directconnect ]

confirm-private-virtual-interface

Description

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

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  confirm-private-virtual-interface
--virtual-interface-id <value>
[--virtual-gateway-id <value>]
[--direct-connect-gateway-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--virtual-interface-id (string)

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

--virtual-gateway-id (string)

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

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

Default: None

--direct-connect-gateway-id (string)

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

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

Default: None

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To accept ownership of a private virtual interface

The following confirm-private-virtual-interface command accepts ownership of a private virtual interface created by another customer:

aws directconnect confirm-private-virtual-interface --virtual-interface-id dxvif-fgy8orxu --virtual-gateway-id vgw-e4a47df9

Output:

{
    "virtualInterfaceState": "pending"
}

Output

virtualInterfaceState -> (string)

State of the virtual interface.

  • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  • Available : A virtual interface that is able to forward traffic.
  • Down : A virtual interface that is BGP down.
  • Deleting : A virtual interface is in this state immediately after calling delete-virtual-interface until it can no longer forward traffic.
  • Deleted : A virtual interface that cannot forward traffic.
  • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.