:doc:`EC2 <../../ec2>` / Client / create_local_gateway_virtual_interface

**************************************
create_local_gateway_virtual_interface
**************************************



.. py:method:: EC2.Client.create_local_gateway_virtual_interface(**kwargs)

  

  Create a virtual interface for a local gateway.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CreateLocalGatewayVirtualInterface>`_  


  **Request Syntax**
  ::

    response = client.create_local_gateway_virtual_interface(
        LocalGatewayVirtualInterfaceGroupId='string',
        OutpostLagId='string',
        Vlan=123,
        LocalAddress='string',
        PeerAddress='string',
        PeerBgpAsn=123,
        TagSpecifications=[
            {
                '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'|'image-usage-report'|'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-metering-policy'|'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'|'vpc-encryption-control'|'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'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        DryRun=True|False,
        PeerBgpAsnExtended=123
    )
    
  :type LocalGatewayVirtualInterfaceGroupId: string
  :param LocalGatewayVirtualInterfaceGroupId: **[REQUIRED]** 

    The ID of the local gateway virtual interface group.

    

  
  :type OutpostLagId: string
  :param OutpostLagId: **[REQUIRED]** 

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

    

  
  :type Vlan: integer
  :param Vlan: **[REQUIRED]** 

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

    

  
  :type LocalAddress: string
  :param LocalAddress: **[REQUIRED]** 

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

    

  
  :type PeerAddress: string
  :param PeerAddress: **[REQUIRED]** 

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

    

  
  :type PeerBgpAsn: integer
  :param PeerBgpAsn: 

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

    

  
  :type TagSpecifications: list
  :param TagSpecifications: 

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

    

  
    - *(dict) --* 

      The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

       

      .. note::

        

        The ``Valid Values`` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.

        

      

    
      - **ResourceType** *(string) --* 

        The type of resource to tag on creation.

        

      
      - **Tags** *(list) --* 

        The tags to apply to the resource.

        

      
        - *(dict) --* 

          Describes a tag.

          

        
          - **Key** *(string) --* 

            The key of the tag.

             

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

            

          
          - **Value** *(string) --* 

            The value of the tag.

             

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

            

          
        
    
    

  :type DryRun: boolean
  :param 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``.

    

  
  :type PeerBgpAsnExtended: integer
  :param PeerBgpAsnExtended: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'LocalGatewayVirtualInterface': {
              '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': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ],
              'ConfigurationState': 'pending'|'available'|'deleting'|'deleted'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **LocalGatewayVirtualInterface** *(dict) --* 

        Information about the local gateway virtual interface.

        
        

        - **LocalGatewayVirtualInterfaceId** *(string) --* 

          The ID of the virtual interface.

          
        

        - **LocalGatewayId** *(string) --* 

          The ID of the local gateway.

          
        

        - **LocalGatewayVirtualInterfaceGroupId** *(string) --* 

          The ID of the local gateway virtual interface group.

          
        

        - **LocalGatewayVirtualInterfaceArn** *(string) --* 

          The Amazon Resource Number (ARN) of the local gateway virtual interface.

          
        

        - **OutpostLagId** *(string) --* 

          The Outpost LAG ID.

          
        

        - **Vlan** *(integer) --* 

          The ID of the VLAN.

          
        

        - **LocalAddress** *(string) --* 

          The local address.

          
        

        - **PeerAddress** *(string) --* 

          The peer address.

          
        

        - **LocalBgpAsn** *(integer) --* 

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

          
        

        - **PeerBgpAsn** *(integer) --* 

          The peer BGP ASN.

          
        

        - **PeerBgpAsnExtended** *(integer) --* 

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

          
        

        - **OwnerId** *(string) --* 

          The ID of the Amazon Web Services account that owns the local gateway virtual interface.

          
        

        - **Tags** *(list) --* 

          The tags assigned to the virtual interface.

          
          

          - *(dict) --* 

            Describes a tag.

            
            

            - **Key** *(string) --* 

              The key of the tag.

               

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

              
            

            - **Value** *(string) --* 

              The value of the tag.

               

              Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

              
        
      
        

        - **ConfigurationState** *(string) --* 

          The current state of the local gateway virtual interface.

          
    
  