Skip to content

EC2  >  Operations  >  create_local_gateway_virtual_interface

create_local_gateway_virtual_interface

Operation

create_local_gateway_virtual_interface async

create_local_gateway_virtual_interface(input: CreateLocalGatewayVirtualInterfaceInput, plugins: list[Plugin] | None = None) -> CreateLocalGatewayVirtualInterfaceOutput

Create a virtual interface for a local gateway.

Parameters:

Name Type Description Default
input CreateLocalGatewayVirtualInterfaceInput

An instance of CreateLocalGatewayVirtualInterfaceInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateLocalGatewayVirtualInterfaceOutput

An instance of CreateLocalGatewayVirtualInterfaceOutput.

Input

CreateLocalGatewayVirtualInterfaceInput dataclass

Bases: _SerdeShape

Dataclass for CreateLocalGatewayVirtualInterfaceInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

local_address class-attribute instance-attribute
local_address: str | None = ...

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

local_gateway_virtual_interface_group_id class-attribute instance-attribute
local_gateway_virtual_interface_group_id: str | None = ...

The ID of the local gateway virtual interface group.

outpost_lag_id class-attribute instance-attribute
outpost_lag_id: str | None = ...

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

peer_address class-attribute instance-attribute
peer_address: str | None = ...

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

peer_bgp_asn class-attribute instance-attribute
peer_bgp_asn: int | None = ...

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

peer_bgp_asn_extended class-attribute instance-attribute
peer_bgp_asn_extended: int | None = ...

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

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

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

vlan class-attribute instance-attribute
vlan: int | None = ...

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

Output

CreateLocalGatewayVirtualInterfaceOutput dataclass

Bases: _SerdeShape

Dataclass for CreateLocalGatewayVirtualInterfaceOutput structure.

Attributes

local_gateway_virtual_interface class-attribute instance-attribute
local_gateway_virtual_interface: LocalGatewayVirtualInterface | None = ...

Information about the local gateway virtual interface.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.