1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. LocalGatewayVirtualInterface

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.LocalGatewayVirtualInterface

Get Started
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for Local Gateway Virtual Interface which describes a virtual interface for AWS Outposts local gateways.

    Create LocalGatewayVirtualInterface Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LocalGatewayVirtualInterface(name: string, args: LocalGatewayVirtualInterfaceArgs, opts?: CustomResourceOptions);
    @overload
def LocalGatewayVirtualInterface(resource_name: str,
                                 args: LocalGatewayVirtualInterfaceArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def LocalGatewayVirtualInterface(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 local_address: Optional[str] = None,
                                 local_gateway_virtual_interface_group_id: Optional[str] = None,
                                 outpost_lag_id: Optional[str] = None,
                                 peer_address: Optional[str] = None,
                                 vlan: Optional[int] = None,
                                 peer_bgp_asn: Optional[int] = None,
                                 peer_bgp_asn_extended: Optional[int] = None,
                                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewLocalGatewayVirtualInterface(ctx *Context, name string, args LocalGatewayVirtualInterfaceArgs, opts ...ResourceOption) (*LocalGatewayVirtualInterface, error)
    public LocalGatewayVirtualInterface(string name, LocalGatewayVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
    public LocalGatewayVirtualInterface(String name, LocalGatewayVirtualInterfaceArgs args)
public LocalGatewayVirtualInterface(String name, LocalGatewayVirtualInterfaceArgs args, CustomResourceOptions options)

    type: aws-native:ec2:LocalGatewayVirtualInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LocalGatewayVirtualInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LocalGatewayVirtualInterfaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LocalGatewayVirtualInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalGatewayVirtualInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalGatewayVirtualInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LocalGatewayVirtualInterface Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LocalGatewayVirtualInterface resource accepts the following input properties:

    LocalAddress string
    The local address.
    LocalGatewayVirtualInterfaceGroupId string
    The ID of the virtual interface group
    OutpostLagId string
    The Outpost LAG ID.
    PeerAddress string
    The peer address.
    Vlan int
    The ID of the VLAN.
    PeerBgpAsn int
    The peer BGP ASN.
    PeerBgpAsnExtended int
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    LocalAddress string
    The local address.
    LocalGatewayVirtualInterfaceGroupId string
    The ID of the virtual interface group
    OutpostLagId string
    The Outpost LAG ID.
    PeerAddress string
    The peer address.
    Vlan int
    The ID of the VLAN.
    PeerBgpAsn int
    The peer BGP ASN.
    PeerBgpAsnExtended int
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    localAddress String
    The local address.
    localGatewayVirtualInterfaceGroupId String
    The ID of the virtual interface group
    outpostLagId String
    The Outpost LAG ID.
    peerAddress String
    The peer address.
    vlan Integer
    The ID of the VLAN.
    peerBgpAsn Integer
    The peer BGP ASN.
    peerBgpAsnExtended Integer
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    localAddress string
    The local address.
    localGatewayVirtualInterfaceGroupId string
    The ID of the virtual interface group
    outpostLagId string
    The Outpost LAG ID.
    peerAddress string
    The peer address.
    vlan number
    The ID of the VLAN.
    peerBgpAsn number
    The peer BGP ASN.
    peerBgpAsnExtended number
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    local_address str
    The local address.
    local_gateway_virtual_interface_group_id str
    The ID of the virtual interface group
    outpost_lag_id str
    The Outpost LAG ID.
    peer_address str
    The peer address.
    vlan int
    The ID of the VLAN.
    peer_bgp_asn int
    The peer BGP ASN.
    peer_bgp_asn_extended int
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    localAddress String
    The local address.
    localGatewayVirtualInterfaceGroupId String
    The ID of the virtual interface group
    outpostLagId String
    The Outpost LAG ID.
    peerAddress String
    The peer address.
    vlan Number
    The ID of the VLAN.
    peerBgpAsn Number
    The peer BGP ASN.
    peerBgpAsnExtended Number
    The extended 32-bit ASN of the BGP peer for use with larger ASN values.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocalGatewayVirtualInterface resource produces the following output properties:

    ConfigurationState string
    The current state of the local gateway virtual interface
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalBgpAsn int
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    LocalGatewayId string
    The ID of the local gateway
    LocalGatewayVirtualInterfaceId string
    The ID of the virtual interface
    OwnerId string
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group
    ConfigurationState string
    The current state of the local gateway virtual interface
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalBgpAsn int
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    LocalGatewayId string
    The ID of the local gateway
    LocalGatewayVirtualInterfaceId string
    The ID of the virtual interface
    OwnerId string
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group
    configurationState String
    The current state of the local gateway virtual interface
    id String
    The provider-assigned unique ID for this managed resource.
    localBgpAsn Integer
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    localGatewayId String
    The ID of the local gateway
    localGatewayVirtualInterfaceId String
    The ID of the virtual interface
    ownerId String
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group
    configurationState string
    The current state of the local gateway virtual interface
    id string
    The provider-assigned unique ID for this managed resource.
    localBgpAsn number
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    localGatewayId string
    The ID of the local gateway
    localGatewayVirtualInterfaceId string
    The ID of the virtual interface
    ownerId string
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group
    configuration_state str
    The current state of the local gateway virtual interface
    id str
    The provider-assigned unique ID for this managed resource.
    local_bgp_asn int
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    local_gateway_id str
    The ID of the local gateway
    local_gateway_virtual_interface_id str
    The ID of the virtual interface
    owner_id str
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group
    configurationState String
    The current state of the local gateway virtual interface
    id String
    The provider-assigned unique ID for this managed resource.
    localBgpAsn Number
    The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
    localGatewayId String
    The ID of the local gateway
    localGatewayVirtualInterfaceId String
    The ID of the virtual interface
    ownerId String
    The ID of the Amazon Web Services account that owns the local gateway virtual interface group

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate