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

******************
create_vpn_gateway
******************



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

  

  Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

   

  For more information, see `Amazon Web Services Site-to-Site VPN <https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html>`__ in the *Amazon Web Services Site-to-Site VPN User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.create_vpn_gateway(
        AvailabilityZone='string',
        Type='ipsec.1',
        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'
                    },
                ]
            },
        ],
        AmazonSideAsn=123,
        DryRun=True|False
    )
    
  :type AvailabilityZone: string
  :param AvailabilityZone: 

    The Availability Zone for the virtual private gateway.

    

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

    The type of VPN connection this virtual private gateway supports.

    

  
  :type TagSpecifications: list
  :param TagSpecifications: 

    The tags to apply to the virtual private gateway.

    

  
    - *(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 AmazonSideAsn: integer
  :param AmazonSideAsn: 

    A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

     

    Default: 64512

    

  
  :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``.

    

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

    
    ::

      {
          'VpnGateway': {
              'AmazonSideAsn': 123,
              'Tags': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ],
              'VpnGatewayId': 'string',
              'State': 'pending'|'available'|'deleting'|'deleted',
              'Type': 'ipsec.1',
              'AvailabilityZone': 'string',
              'VpcAttachments': [
                  {
                      'VpcId': 'string',
                      'State': 'attaching'|'attached'|'detaching'|'detached'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the output of CreateVpnGateway.

      
      

      - **VpnGateway** *(dict) --* 

        Information about the virtual private gateway.

        
        

        - **AmazonSideAsn** *(integer) --* 

          The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

          
        

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

          Any tags assigned to the virtual private gateway.

          
          

          - *(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.

              
        
      
        

        - **VpnGatewayId** *(string) --* 

          The ID of the virtual private gateway.

          
        

        - **State** *(string) --* 

          The current state of the virtual private gateway.

          
        

        - **Type** *(string) --* 

          The type of VPN connection the virtual private gateway supports.

          
        

        - **AvailabilityZone** *(string) --* 

          The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

          
        

        - **VpcAttachments** *(list) --* 

          Any VPCs attached to the virtual private gateway.

          
          

          - *(dict) --* 

            Describes an attachment between a virtual private gateway and a VPC.

            
            

            - **VpcId** *(string) --* 

              The ID of the VPC.

              
            

            - **State** *(string) --* 

              The current state of the attachment.

              
        
      
    
  