Create Local Gateway Virtual Interface

ec2_create_local_gateway_virtual_interface

R Documentation

Create a virtual interface for a local gateway¶

Description¶

Create a virtual interface for a local gateway.

Usage¶

ec2_create_local_gateway_virtual_interface(
  LocalGatewayVirtualInterfaceGroupId, OutpostLagId, Vlan, LocalAddress,
  PeerAddress, PeerBgpAsn, TagSpecifications, DryRun, PeerBgpAsnExtended)

Arguments¶

LocalGatewayVirtualInterfaceGroupId

[required] The ID of the local gateway virtual interface group.

OutpostLagId

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

Vlan

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

LocalAddress

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

PeerAddress

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

PeerBgpAsn

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

TagSpecifications

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

DryRun

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.

PeerBgpAsnExtended

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

Value¶

A list with the following syntax:

list(
  LocalGatewayVirtualInterface = list(
    LocalGatewayVirtualInterfaceId = "string",
    LocalGatewayId = "string",
    LocalGatewayVirtualInterfaceGroupId = "string",
    LocalGatewayVirtualInterfaceArn = "string",
    OutpostLagId = "string",
    Vlan = 123,
    LocalAddress = "string",
    PeerAddress = "string",
    LocalBgpAsn = 123,
    PeerBgpAsn = 123,
    PeerBgpAsnExtended = 123,
    OwnerId = "string",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    ConfigurationState = "pending"|"available"|"deleting"|"deleted"
  )
)

Request syntax¶

svc$create_local_gateway_virtual_interface(
  LocalGatewayVirtualInterfaceGroupId = "string",
  OutpostLagId = "string",
  Vlan = 123,
  LocalAddress = "string",
  PeerAddress = "string",
  PeerBgpAsn = 123,
  TagSpecifications = list(
    list(
      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",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  DryRun = TRUE|FALSE,
  PeerBgpAsnExtended = 123
)