.. _CreateVpnConnection:

###################
CreateVpnConnection
###################

***********
Description
***********

Запрос на создание VPN-соединения между VPN-шлюзом и клиентским шлюзом.

VPN-шлюз создаётся автоматически для каждого виртуального частного облака и его идентификатор можно узнать посредством :ref:`DescribeVpnGateways`. Для удобства — идентификатор VPN-шлюза совпадает с идентификатором VPC, которому он принадлежит (``vpc-ABCD1234``/``vgw-ABCD1234``).

Между парой — клиентский шлюз и VPC (VPN-шлюз), может существовать только одно VPN-соединение. При попытке создать VPN-соединение повторно операция завершится успешно, но будет возвращён объект уже существующего VPN-соединения.

По умолчанию VPN-соединения создаются в режиме отказоустойчивости. Для создания VPN-соединения без поддержки отказоустойчивости (с одним туннелем) необходимо явно указать опции только для одного туннеля.

С другими подробностями можно ознакомиться в :ref:`разделе VPN-соединения <VPNConnectionsManual>`.

******************
Request Parameters
******************

Необходимые параметры
=====================

- *CustomerGatewayId* — Идентификатор клиентского шлюза.

  - Необходимо: Да
  - Тип: String

- *Type* — Тип VPN-соединения.

  - Необходимо: Да
  - Тип: String
  - Возможные значения: ``ipsec.1`` | ``ipsec.legacy``

- *VpnGatewayId* — Идентификатор VPN-шлюза (виртуального частного облака).

  - Необходимо: Да
  - Тип: String

Опциональные параметры
======================

- *Options* — Дополнительные опции для VPN-соединения.

  - Необходимо: Нет
  - Тип: Объект :ref:`VpnConnectionOptionsSpecification`

- *TagSpecification.N* — Теги, назначаемые создаваемому ресурсу.

  - Тип: Список объектов :ref:`TagSpecification`
  - Необходимо: Нет

*****************
Response Elements
*****************

- *requestId* — Идентификатор запроса.

  - Тип: String

- *vpnConnection* — Информация о VPN-соединении.

  - Тип: Список объектов :ref:`VpnConnection`

********
Examples
********

.. code-block:: bash

   c2-ec2 CreateVpnConnection \
      CustomerGatewayId <customer_gateway_id> \
      Type <type> \
      VpnGatewayId <vpn_gateway_id>

.. dropdown:: Теги
   .. code-block:: bash

      c2-ec2 CreateVpnConnection \
         CustomerGatewayId <customer_gateway_id> \
         Type <vpn_type> VpnGatewayId <vpn_gateway_id> \
         TagSpecification.0.ResourceType vpn-connection \
         TagSpecification.0.Tag.0.Key "tag_key" \
         TagSpecification.0.Tag.0.Value "tag_value"

.. dropdown:: Опции

   .. code-block:: bash

      c2-ec2 CreateVpnConnection \
         CustomerGatewayId <customer_gateway_id> \
         Type <vpn_type> \
         VpnGatewayId <vpn_gateway_id> \
         Options.LocalIpv4NetworkCidr "0.0.0.0/0" \
         Options.RemoteIpv4NetworkCidr "0.0.0.0/0"

.. dropdown:: Туннельные опции (с использованием утилиты c2-ec2)

   .. code-block:: bash

      c2-ec2 CreateVpnConnection \
         CustomerGatewayId <customer_gateway_id> \
         Type <vpn_type> \
         VpnGatewayId <vpn_gateway_id> \
         Options.TunnelOptions.0.PreSharedKey <pre_shared_key> \
         Options.TunnelOptions.0.TunnelInsideCidr <tunnel_inside_cidr>
         Options.TunnelOptions.1.IKEVersion.0.Value <ike_version>

      c2-ec2 CreateVpnConnection \
         CustomerGatewayId <customer_gateway_id> \
         Type <vpn_type> \
         VpnGatewayId <vpn_gateway_id> \
         Options.TunnelOptions.0.PreSharedKey <pre_shared_key> \
         Options.TunnelOptions.0.TunnelInsideCidr <tunnel_inside_cidr>
         Options.TunnelOptions.0.IKEVersion.0.Value <ike_version> \
         Options.TunnelOptions.0.Phase1DHGroupNumber.0.Value <p1_dh_group_number> \
         Options.TunnelOptions.0.Phase1DHGroupNumber.1.Value <p1_dh_group_number> \
         Options.TunnelOptions.0.Phase1DHGroupNumber.2.Value <p1_dh_group_number> \
         Options.TunnelOptions.0.Phase1EncryptionAlgorithm.0.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.0.Phase1EncryptionAlgorithm.1.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.0.Phase1EncryptionAlgorithm.2.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.0.Phase1EncryptionAlgorithm.3.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.0.Phase1IntegrityAlgorithm.0.Value <p1_integrity_algorithm> \
         Options.TunnelOptions.0.Phase1IntegrityAlgorithm.1.Value <p1_integrity_algorithm> \
         Options.TunnelOptions.0.Phase1LifetimeSeconds <p1_lifetime> \
         Options.TunnelOptions.0.Phase2DHGroupNumber.0.Value <p2_dh_group_number> \
         Options.TunnelOptions.0.Phase2EncryptionAlgorithm.0.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.0.Phase2EncryptionAlgorithm.1.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.0.Phase2EncryptionAlgorithm.2.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.0.Phase2IntegrityAlgorithm.0.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.0.Phase2IntegrityAlgorithm.1.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.0.Phase2IntegrityAlgorithm.2.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.0.Phase2IntegrityAlgorithm.3.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.0.Phase2LifetimeSeconds <p2_lifetime>
         Options.TunnelOptions.0.ReplayWindowSize <ike_replay_window_size>
         Options.TunnelOptions.1.PreSharedKey <pre_shared_key> \
         Options.TunnelOptions.1.TunnelInsideCidr <tunnel_inside_cidr>
         Options.TunnelOptions.1.IKEVersion.0.Value <ike_version> \
         Options.TunnelOptions.1.Phase1DHGroupNumber.0.Value <p1_dh_group_number> \
         Options.TunnelOptions.1.Phase1DHGroupNumber.1.Value <p1_dh_group_number> \
         Options.TunnelOptions.1.Phase1DHGroupNumber.2.Value <p1_dh_group_number> \
         Options.TunnelOptions.1.Phase1EncryptionAlgorithm.0.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.1.Phase1EncryptionAlgorithm.1.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.1.Phase1EncryptionAlgorithm.2.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.1.Phase1EncryptionAlgorithm.3.Value <p1_encryption_algorithm> \
         Options.TunnelOptions.1.Phase1IntegrityAlgorithm.0.Value <p1_integrity_algorithm> \
         Options.TunnelOptions.1.Phase1IntegrityAlgorithm.1.Value <p1_integrity_algorithm> \
         Options.TunnelOptions.1.Phase1LifetimeSeconds <p1_lifetime> \
         Options.TunnelOptions.1.Phase2DHGroupNumber.0.Value <p2_dh_group_number> \
         Options.TunnelOptions.1.Phase2EncryptionAlgorithm.0.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.1.Phase2EncryptionAlgorithm.1.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.1.Phase2EncryptionAlgorithm.2.Value <p2_encryption_algorithm> \
         Options.TunnelOptions.1.Phase2IntegrityAlgorithm.0.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.1.Phase2IntegrityAlgorithm.1.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.1.Phase2IntegrityAlgorithm.2.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.1.Phase2IntegrityAlgorithm.3.Value <p2_integrity_algorithm> \
         Options.TunnelOptions.1.Phase2LifetimeSeconds <p2_lifetime>
         Options.TunnelOptions.1.ReplayWindowSize <ike_replay_window_size>

.. dropdown:: Туннельные опции (с использованием awscli)

   .. code-block:: bash

      aws <...> create-vpn-connection
         --type <vpn_type>
         --customer-gateway-id <cgw_id>
         --vpn-gateway-id <vgw_id>
         --options "{
            \"LocalIpv4NetworkCidr\": \"<local_network_cidr>\",
            \"RemoteIpv4NetworkCidr: \"<remote_network_cidr>\",
            \"TunnelOptions\": [
               {
                  \"PreSharedKey\": \"<pre_shared_key>\",
                  \"TunnelInsideCidr\": \"<tunnel_inside_cidr>\",
                  \"IKEVersions\": [
                     {\"Value\": \"<ike_version>\"}
                  ],
                  \"ReplayWindowSize\": <ike_replay_window_size>,
                  \"Phase1DHGroupNumbers\": [
                     {\"Value\": <p1_dh_group_num>},
                     {\"Value\": <p1_dh_group_num>},
                     <...>
                  ],
                  \"Phase1EncryptionAlgorithms\": [
                     {\"Value\": \"<p1_encryption_alg>\"},
                     {\"Value\": \"<p1_encryption_alg>\"},
                     <...>
                  ],
                  \"Phase1IntegrityAlgorithms\": [
                     {\"Value\": \"<p1_integrity_alg>\"},
                     {\"Value\": \"<p1_integrity_alg>\"},
                     <...>
                  ],
                  \"Phase1LifetimeSeconds\": <p1_lifetime>,
                  \"Phase2DHGroupNumbers\": [
                     {\"Value\": <p2_dh_group_num>}
                  ],
                  \"Phase2EncryptionAlgorithms\": [
                     {\"Value\": \"<p2_encryption_alg>\"},
                     {\"Value\": \"<p2_encryption_alg>\"},
                     <...>
                  ],
                  \"Phase2IntegrityAlgorithms\": [
                     {\"Value\": \"<p2_integrity_alg>\"},
                     {\"Value\": \"<p2_integrity_alg>\"},
                     <...>
                  ],
                  \"Phase2LifetimeSeconds\": <p2_lifetime>
               },
               {
                  \"PreSharedKey\": \"<pre_shared_key>\",
                  \"TunnelInsideCidr\": \"<tunnel_inside_cidr>\",
                  \"IKEVersions\": [
                     {\"Value\": \"<ike_version>\"}
                  ],
                  \"ReplayWindowSize\": <ike_replay_window_size>,
                  \"Phase1DHGroupNumbers\": [
                     {\"Value\": <p1_dh_group_num>},
                     {\"Value\": <p1_dh_group_num>},
                     <...>
                  ],
                  \"Phase1EncryptionAlgorithms\": [
                     {\"Value\": \"<p1_encryption_alg>\"},
                     {\"Value\": \"<p1_encryption_alg>\"},
                     <...>
                  ],
                  \"Phase1IntegrityAlgorithms\": [
                     {\"Value\": \"<p1_integrity_alg>\"},
                     {\"Value\": \"<p1_integrity_alg>\"},
                     <...>
                  ],
                  \"Phase1LifetimeSeconds\": <p1_lifetime>,
                  \"Phase2DHGroupNumbers\": [
                     {\"Value\": <p2_dh_group_num>}
                  ],
                  \"Phase2EncryptionAlgorithms\": [
                     {\"Value\": \"<p2_encryption_alg>\"},
                     {\"Value\": \"<p2_encryption_alg>\"},
                     <...>
                  ],
                  \"Phase2IntegrityAlgorithms\": [
                     {\"Value\": \"<p2_integrity_alg>\"},
                     {\"Value\": \"<p2_integrity_alg>\"},
                     <...>
                  ],
                  \"Phase2LifetimeSeconds\": <p2_lifetime>
               }
            ]
         }"