create-vpn-connection¶

Description¶

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported connection type is ipsec.1 .

The response includes information that you need to give to your network administrator to configure your customer gateway.

Warning

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn’t return an error.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .

Synopsis¶

  create-vpn-connection
--customer-gateway-id <value>
--type <value>
[--vpn-gateway-id <value>]
[--transit-gateway-id <value>]
[--dry-run | --no-dry-run]
[--options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--customer-gateway-id (string)

The ID of the customer gateway.

--type (string)

The type of VPN connection (ipsec.1 ).

--vpn-gateway-id (string)

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

--transit-gateway-id (string)

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

--dry-run | --no-dry-run (boolean)

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 .

--options (structure)

The options for the VPN connection.

EnableAcceleration -> (boolean)

Indicate whether to enable acceleration for the VPN connection.

Default: false

StaticRoutesOnly -> (boolean)

Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true . Use CreateVpnConnectionRoute to create a static route.

Default: false

TunnelOptions -> (list)

The tunnel options for the VPN connection.

(structure)

The tunnel options for a single VPN tunnel.

TunnelInsideCidr -> (string)

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:

169.254.0.0/30

169.254.1.0/30

169.254.2.0/30

169.254.3.0/30

169.254.4.0/30

169.254.5.0/30

169.254.169.252/30

PreSharedKey -> (string)

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.

Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).

Phase1LifetimeSeconds -> (integer)

The lifetime for phase 1 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 28,800.

Default: 28800

Phase2LifetimeSeconds -> (integer)

The lifetime for phase 2 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds .

Default: 3600

RekeyMarginTimeSeconds -> (integer)

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage .

Constraints: A value between 60 and half of Phase2LifetimeSeconds .

Default: 540

RekeyFuzzPercentage -> (integer)

The percentage of the rekey window (determined by RekeyMarginTimeSeconds ) during which the rekey time is randomly selected.

Constraints: A value between 0 and 100.

Default: 100

ReplayWindowSize -> (integer)

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

DPDTimeoutSeconds -> (integer)

The number of seconds after which a DPD timeout occurs.

Constraints: A value between 0 and 30.

Default: 30

Phase1EncryptionAlgorithms -> (list)

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256

(structure)

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.

Value -> (string)

The value for the encryption algorithm.

Phase2EncryptionAlgorithms -> (list)

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256

(structure)

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.

Value -> (string)

The encryption algorithm.

Phase1IntegrityAlgorithms -> (list)

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256

(structure)

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.

Value -> (string)

The value for the integrity algorithm.

Phase2IntegrityAlgorithms -> (list)

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256

(structure)

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.

Value -> (string)

The integrity algorithm.

Phase1DHGroupNumbers -> (list)

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

(structure)

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

Phase2DHGroupNumbers -> (list)

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

(structure)

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

IKEVersions -> (list)

The IKE versions that are permitted for the VPN tunnel.

Valid values: ikev1 | ikev2

(structure)

The IKE version that is permitted for the VPN tunnel.

Value -> (string)

The IKE version.

JSON Syntax:

{
  "EnableAcceleration": true|false,
  "StaticRoutesOnly": true|false,
  "TunnelOptions": [
    {
      "TunnelInsideCidr": "string",
      "PreSharedKey": "string",
      "Phase1LifetimeSeconds": integer,
      "Phase2LifetimeSeconds": integer,
      "RekeyMarginTimeSeconds": integer,
      "RekeyFuzzPercentage": integer,
      "ReplayWindowSize": integer,
      "DPDTimeoutSeconds": integer,
      "Phase1EncryptionAlgorithms": [
        {
          "Value": "string"
        }
        ...
      ],
      "Phase2EncryptionAlgorithms": [
        {
          "Value": "string"
        }
        ...
      ],
      "Phase1IntegrityAlgorithms": [
        {
          "Value": "string"
        }
        ...
      ],
      "Phase2IntegrityAlgorithms": [
        {
          "Value": "string"
        }
        ...
      ],
      "Phase1DHGroupNumbers": [
        {
          "Value": integer
        }
        ...
      ],
      "Phase2DHGroupNumbers": [
        {
          "Value": integer
        }
        ...
      ],
      "IKEVersions": [
        {
          "Value": "string"
        }
        ...
      ]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a VPN connection with dynamic routing

This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The output includes the configuration information that your network administrator needs, in XML format.

Command:

aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-0e11f167 --vpn-gateway-id vgw-9a4cacf3

Output:

{
    "VpnConnection": {
        "VpnConnectionId": "vpn-1a2b3c4d"
        "CustomerGatewayConfiguration": "...configuration information...",
        "State": "available",
        "VpnGatewayId": "vgw-9a4cacf3",
        "CustomerGatewayId": "cgw-0e11f167"
    }
}

To create a VPN connection with static routing

This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The options specify static routing. The output includes the configuration information that your network administrator needs, in XML format.

Command:

aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-1a1a1a1a --vpn-gateway-id vgw-9a4cacf3 --options "{\"StaticRoutesOnly\":true}"

Output:

{
    "VpnConnection": {
        "VpnConnectionId": "vpn-11aa33cc"
        "CustomerGatewayConfiguration": "...configuration information...",
        "State": "pending",
        "VpnGatewayId": "vgw-9a4cacf3",
        "CustomerGatewayId": "cgw-1a1a1a1a",
        "Options": {
            "StaticRoutesOnly": true
        }
    }
}

To create a VPN connection and specify your own inside CIDR and pre-shared key

This example creates a VPN connection and specifies the inside IP address CIDR block and a custom pre-shared key for each tunnel. The specified values are returned in the CustomerGatewayConfiguration information.

Command:

aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-b4de3fdd --vpn-gateway-id vgw-f211f09b --options "{"StaticRoutesOnly":false,"TunnelOptions":[{"TunnelInsideCidr":"169.254.12.0/30","PreSharedKey":"ExamplePreSharedKey1"},{"TunnelInsideCidr":"169.254.13.0/30","PreSharedKey":"ExamplePreSharedKey2"}]}"

Output:

{
    "VpnConnection": {
        "VpnConnectionId": "vpn-40f41529"
        "CustomerGatewayConfiguration": "...configuration information...",
        "State": "pending",
        "VpnGatewayId": "vgw-f211f09b",
        "CustomerGatewayId": "cgw-b4de3fdd"
    }
}

Output¶

VpnConnection -> (structure)

Information about the VPN connection.

CustomerGatewayConfiguration -> (string)

The configuration information for the VPN connection’s customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it’s present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

CustomerGatewayId -> (string)

The ID of the customer gateway at your end of the VPN connection.

Category -> (string)

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.

State -> (string)

The current state of the VPN connection.

Type -> (string)

The type of VPN connection.

VpnConnectionId -> (string)

The ID of the VPN connection.

VpnGatewayId -> (string)

The ID of the virtual private gateway at the AWS side of the VPN connection.

TransitGatewayId -> (string)

The ID of the transit gateway associated with the VPN connection.

Options -> (structure)

The VPN connection options.

EnableAcceleration -> (boolean)

Indicates whether acceleration is enabled for the VPN connection.

StaticRoutesOnly -> (boolean)

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don’t support BGP.

TunnelOptions -> (list)

Indicates the VPN tunnel options.

(structure)

The VPN tunnel options.

OutsideIpAddress -> (string)

The external IP address of the VPN tunnel.

TunnelInsideCidr -> (string)

The range of inside IP addresses for the tunnel.

PreSharedKey -> (string)

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.

Phase1LifetimeSeconds -> (integer)

The lifetime for phase 1 of the IKE negotiation, in seconds.

Phase2LifetimeSeconds -> (integer)

The lifetime for phase 2 of the IKE negotiation, in seconds.

RekeyMarginTimeSeconds -> (integer)

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.

RekeyFuzzPercentage -> (integer)

The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

ReplayWindowSize -> (integer)

The number of packets in an IKE replay window.

DpdTimeoutSeconds -> (integer)

The number of seconds after which a DPD timeout occurs.

Phase1EncryptionAlgorithms -> (list)

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The encryption algorithm for phase 1 IKE negotiations.

Value -> (string)

The value for the encryption algorithm.

Phase2EncryptionAlgorithms -> (list)

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The encryption algorithm for phase 2 IKE negotiations.

Value -> (string)

The encryption algorithm.

Phase1IntegrityAlgorithms -> (list)

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The integrity algorithm for phase 1 IKE negotiations.

Value -> (string)

The value for the integrity algorithm.

Phase2IntegrityAlgorithms -> (list)

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The integrity algorithm for phase 2 IKE negotiations.

Value -> (string)

The integrity algorithm.

Phase1DHGroupNumbers -> (list)

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

(structure)

The Diffie-Hellmann group number for phase 1 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

Phase2DHGroupNumbers -> (list)

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

(structure)

The Diffie-Hellmann group number for phase 2 IKE negotiations.

Value -> (integer)

The Diffie-Hellmann group number.

IkeVersions -> (list)

The IKE versions that are permitted for the VPN tunnel.

(structure)

The internet key exchange (IKE) version permitted for the VPN tunnel.

Value -> (string)

The IKE version.

Routes -> (list)

The static routes associated with the VPN connection.

(structure)

Describes a static route for a VPN connection.

DestinationCidrBlock -> (string)

The CIDR block associated with the local subnet of the customer data center.

Source -> (string)

Indicates how the routes were provided.

State -> (string)

The current state of the static route.

Tags -> (list)

Any tags assigned to the VPN connection.

(structure)

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 255 Unicode characters.

VgwTelemetry -> (list)

Information about the VPN tunnel.

(structure)

Describes telemetry for a VPN tunnel.

AcceptedRouteCount -> (integer)

The number of accepted routes.

LastStatusChange -> (timestamp)

The date and time of the last change in status.

OutsideIpAddress -> (string)

The Internet-routable IP address of the virtual private gateway’s outside interface.

Status -> (string)

The status of the VPN tunnel.

StatusMessage -> (string)

If an error occurs, a description of the error.

CertificateArn -> (string)

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

Table of Contents

Feedback

User Guide

create-vpn-connection¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶