CreateLocalGatewayVirtualInterfaceCommand

Suggest an Edit

Create a virtual interface for a local gateway.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, CreateLocalGatewayVirtualInterfaceCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, CreateLocalGatewayVirtualInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // CreateLocalGatewayVirtualInterfaceRequest
  LocalGatewayVirtualInterfaceGroupId: "STRING_VALUE", // required
  OutpostLagId: "STRING_VALUE", // required
  Vlan: Number("int"), // required
  LocalAddress: "STRING_VALUE", // required
  PeerAddress: "STRING_VALUE", // required
  PeerBgpAsn: Number("int"),
  TagSpecifications: [ // TagSpecificationList
    { // TagSpecification
      ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "declarative-policies-report" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "outpost-lag" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "service-link-virtual-interface" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "route-server" || "route-server-endpoint" || "route-server-peer" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint" || "verified-access-endpoint-target" || "ipam-external-resource-verification-token" || "mac-modification-task",
      Tags: [ // TagList
        { // Tag
          Key: "STRING_VALUE",
          Value: "STRING_VALUE",
        },
      ],
    },
  ],
  DryRun: true || false,
  PeerBgpAsnExtended: Number("long"),
};
const command = new CreateLocalGatewayVirtualInterfaceCommand(input);
const response = await client.send(command);
// { // CreateLocalGatewayVirtualInterfaceResult
//   LocalGatewayVirtualInterface: { // LocalGatewayVirtualInterface
//     LocalGatewayVirtualInterfaceId: "STRING_VALUE",
//     LocalGatewayId: "STRING_VALUE",
//     LocalGatewayVirtualInterfaceGroupId: "STRING_VALUE",
//     LocalGatewayVirtualInterfaceArn: "STRING_VALUE",
//     OutpostLagId: "STRING_VALUE",
//     Vlan: Number("int"),
//     LocalAddress: "STRING_VALUE",
//     PeerAddress: "STRING_VALUE",
//     LocalBgpAsn: Number("int"),
//     PeerBgpAsn: Number("int"),
//     PeerBgpAsnExtended: Number("long"),
//     OwnerId: "STRING_VALUE",
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     ConfigurationState: "pending" || "available" || "deleting" || "deleted",
//   },
// };

CreateLocalGatewayVirtualInterfaceCommand Input

See CreateLocalGatewayVirtualInterfaceCommandInput for more details

Parameter
Type
Description
LocalAddress
Required
string | undefined

The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.

LocalGatewayVirtualInterfaceGroupId
Required
string | undefined

The ID of the local gateway virtual interface group.

OutpostLagId
Required
string | undefined

References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.

PeerAddress
Required
string | undefined

The peer IP address for the local gateway virtual interface. Only IPv4 is supported.

Vlan
Required
number | undefined

The virtual local area network (VLAN) used for the local gateway virtual interface.

DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

PeerBgpAsn
number | undefined

The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.

PeerBgpAsnExtended
number | undefined

The extended 32-bit ASN of the BGP peer for use with larger ASN values.

TagSpecifications
TagSpecification[] | undefined

The tags to apply to a resource when the local gateway virtual interface is being created.

CreateLocalGatewayVirtualInterfaceCommand Output

See CreateLocalGatewayVirtualInterfaceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LocalGatewayVirtualInterface
LocalGatewayVirtualInterface | undefined

Information about the local gateway virtual interface.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.