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

Amazonka.EC2.CreateVpnConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data CreateVpnConnection Source #

Contains the parameters for CreateVpnConnection.

See: newCreateVpnConnection smart constructor.

Constructors

CreateVpnConnection'

Fields

dryRun :: Maybe Bool
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 :: Maybe VpnConnectionOptionsSpecification
The options for the VPN connection.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the VPN connection.
transitGatewayId :: Maybe Text
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
vpnGatewayId :: Maybe Text
The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
customerGatewayId :: Text
The ID of the customer gateway.
type' :: Text
The type of VPN connection (ipsec.1).

Instances

Instances details

ToHeaders CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods toHeaders :: CreateVpnConnection -> [Header] #
ToPath CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods toPath :: CreateVpnConnection -> ByteString #
ToQuery CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods toQuery :: CreateVpnConnection -> QueryString #
AWSRequest CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Associated Types type AWSResponse CreateVpnConnection # Methods request :: (Service -> Service) -> CreateVpnConnection -> Request CreateVpnConnection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateVpnConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateVpnConnection))) #
Generic CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Associated Types type Rep CreateVpnConnection :: Type -> Type # Methods from :: CreateVpnConnection -> Rep CreateVpnConnection x # to :: Rep CreateVpnConnection x -> CreateVpnConnection #
Read CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods readsPrec :: Int -> ReadS CreateVpnConnection # readList :: ReadS [CreateVpnConnection] # readPrec :: ReadPrec CreateVpnConnection # readListPrec :: ReadPrec [CreateVpnConnection] #
Show CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods showsPrec :: Int -> CreateVpnConnection -> ShowS # show :: CreateVpnConnection -> String # showList :: [CreateVpnConnection] -> ShowS #
NFData CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods rnf :: CreateVpnConnection -> () #
Eq CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods (==) :: CreateVpnConnection -> CreateVpnConnection -> Bool # (/=) :: CreateVpnConnection -> CreateVpnConnection -> Bool #
Hashable CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods hashWithSalt :: Int -> CreateVpnConnection -> Int # hash :: CreateVpnConnection -> Int #
type AWSResponse CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection type AWSResponse CreateVpnConnection = CreateVpnConnectionResponse
type Rep CreateVpnConnection Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection type Rep CreateVpnConnection = D1 ('MetaData "CreateVpnConnection" "Amazonka.EC2.CreateVpnConnection" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateVpnConnection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpnConnectionOptionsSpecification)) :: S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])))) :: ((S1 ('MetaSel ('Just "transitGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpnGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "customerGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateVpnConnection Source #

Arguments

:: Text	`CreateVpnConnection`
-> Text	`CreateVpnConnection`
-> CreateVpnConnection

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.

Constructors

CreateVpnConnectionResponse'
Fields vpnConnection :: Maybe VpnConnection Information about the VPN connection. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Associated Types type Rep CreateVpnConnectionResponse :: Type -> Type # Methods from :: CreateVpnConnectionResponse -> Rep CreateVpnConnectionResponse x # to :: Rep CreateVpnConnectionResponse x -> CreateVpnConnectionResponse #
Read CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods readsPrec :: Int -> ReadS CreateVpnConnectionResponse # readList :: ReadS [CreateVpnConnectionResponse] # readPrec :: ReadPrec CreateVpnConnectionResponse # readListPrec :: ReadPrec [CreateVpnConnectionResponse] #
Show CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods showsPrec :: Int -> CreateVpnConnectionResponse -> ShowS # show :: CreateVpnConnectionResponse -> String # showList :: [CreateVpnConnectionResponse] -> ShowS #
NFData CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods rnf :: CreateVpnConnectionResponse -> () #
Eq CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection Methods (==) :: CreateVpnConnectionResponse -> CreateVpnConnectionResponse -> Bool # (/=) :: CreateVpnConnectionResponse -> CreateVpnConnectionResponse -> Bool #
type Rep CreateVpnConnectionResponse Source #
Instance details Defined in Amazonka.EC2.CreateVpnConnection type Rep CreateVpnConnectionResponse = D1 ('MetaData "CreateVpnConnectionResponse" "Amazonka.EC2.CreateVpnConnection" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateVpnConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpnConnection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpnConnection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateVpnConnectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateVpnConnectionResponse'`
-> CreateVpnConnectionResponse

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.