Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a VPN connection between an existing virtual private gateway or
transit gateway and a 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.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
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 Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
Synopsis
- data CreateVpnConnection = CreateVpnConnection' {}
- newCreateVpnConnection :: Text -> Text -> CreateVpnConnection
- createVpnConnection_dryRun :: Lens' CreateVpnConnection (Maybe Bool)
- createVpnConnection_options :: Lens' CreateVpnConnection (Maybe VpnConnectionOptionsSpecification)
- createVpnConnection_tagSpecifications :: Lens' CreateVpnConnection (Maybe [TagSpecification])
- createVpnConnection_transitGatewayId :: Lens' CreateVpnConnection (Maybe Text)
- createVpnConnection_vpnGatewayId :: Lens' CreateVpnConnection (Maybe Text)
- createVpnConnection_customerGatewayId :: Lens' CreateVpnConnection Text
- createVpnConnection_type :: Lens' CreateVpnConnection Text
- data CreateVpnConnectionResponse = CreateVpnConnectionResponse' {}
- newCreateVpnConnectionResponse :: Int -> CreateVpnConnectionResponse
- createVpnConnectionResponse_vpnConnection :: Lens' CreateVpnConnectionResponse (Maybe VpnConnection)
- createVpnConnectionResponse_httpStatus :: Lens' CreateVpnConnectionResponse Int
Creating a Request
data CreateVpnConnection Source #
Contains the parameters for CreateVpnConnection.
See: newCreateVpnConnection
smart constructor.
CreateVpnConnection' | |
|
Instances
newCreateVpnConnection Source #
Create a value of CreateVpnConnection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:CreateVpnConnection'
, createVpnConnection_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
.
CreateVpnConnection
, createVpnConnection_options
- The options for the VPN connection.
CreateVpnConnection
, createVpnConnection_tagSpecifications
- The tags to apply to the VPN connection.
CreateVpnConnection
, createVpnConnection_transitGatewayId
- The ID of the transit gateway. If you specify a transit gateway, you
cannot specify a virtual private gateway.
CreateVpnConnection
, createVpnConnection_vpnGatewayId
- The ID of the virtual private gateway. If you specify a virtual private
gateway, you cannot specify a transit gateway.
CreateVpnConnection
, createVpnConnection_customerGatewayId
- The ID of the customer gateway.
CreateVpnConnection
, createVpnConnection_type
- The type of VPN connection (ipsec.1
).
Request Lenses
createVpnConnection_dryRun :: Lens' CreateVpnConnection (Maybe Bool) Source #
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
.
createVpnConnection_options :: Lens' CreateVpnConnection (Maybe VpnConnectionOptionsSpecification) Source #
The options for the VPN connection.
createVpnConnection_tagSpecifications :: Lens' CreateVpnConnection (Maybe [TagSpecification]) Source #
The tags to apply to the VPN connection.
createVpnConnection_transitGatewayId :: Lens' CreateVpnConnection (Maybe Text) Source #
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
createVpnConnection_vpnGatewayId :: Lens' CreateVpnConnection (Maybe Text) Source #
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
createVpnConnection_customerGatewayId :: Lens' CreateVpnConnection Text Source #
The ID of the customer gateway.
createVpnConnection_type :: Lens' CreateVpnConnection Text Source #
The type of VPN connection (ipsec.1
).
Destructuring the Response
data CreateVpnConnectionResponse Source #
Contains the output of CreateVpnConnection.
See: newCreateVpnConnectionResponse
smart constructor.
CreateVpnConnectionResponse' | |
|
Instances
newCreateVpnConnectionResponse Source #
Create a value of CreateVpnConnectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateVpnConnectionResponse
, createVpnConnectionResponse_vpnConnection
- Information about the VPN connection.
$sel:httpStatus:CreateVpnConnectionResponse'
, createVpnConnectionResponse_httpStatus
- The response's http status code.
Response Lenses
createVpnConnectionResponse_vpnConnection :: Lens' CreateVpnConnectionResponse (Maybe VpnConnection) Source #
Information about the VPN connection.
createVpnConnectionResponse_httpStatus :: Lens' CreateVpnConnectionResponse Int Source #
The response's http status code.