amazonka-ec2-1.4.5: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.CreateCustomerGateway

Contents

Description

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide .

Important: You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

Synopsis

Creating a Request

createCustomerGateway #

Creates a value of CreateCustomerGateway with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ccgDryRun - 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 .
  • ccgType - The type of VPN connection that this customer gateway supports (ipsec.1 ).
  • ccgPublicIP - The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
  • ccgBGPASN - For devices that support BGP, the customer gateway's BGP ASN. Default: 65000

data CreateCustomerGateway #

Contains the parameters for CreateCustomerGateway.

See: createCustomerGateway smart constructor.

Instances

Eq CreateCustomerGateway # 
Data CreateCustomerGateway # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCustomerGateway -> c CreateCustomerGateway #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCustomerGateway #

toConstr :: CreateCustomerGateway -> Constr #

dataTypeOf :: CreateCustomerGateway -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateCustomerGateway) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCustomerGateway) #

gmapT :: (forall b. Data b => b -> b) -> CreateCustomerGateway -> CreateCustomerGateway #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCustomerGateway -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCustomerGateway -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateCustomerGateway -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCustomerGateway -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCustomerGateway -> m CreateCustomerGateway #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCustomerGateway -> m CreateCustomerGateway #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCustomerGateway -> m CreateCustomerGateway #

Read CreateCustomerGateway # 
Show CreateCustomerGateway # 
Generic CreateCustomerGateway # 
Hashable CreateCustomerGateway # 
NFData CreateCustomerGateway # 

Methods

rnf :: CreateCustomerGateway -> () #

AWSRequest CreateCustomerGateway # 
ToQuery CreateCustomerGateway # 
ToPath CreateCustomerGateway # 
ToHeaders CreateCustomerGateway # 
type Rep CreateCustomerGateway # 
type Rep CreateCustomerGateway = D1 (MetaData "CreateCustomerGateway" "Network.AWS.EC2.CreateCustomerGateway" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "CreateCustomerGateway'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccgDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ccgType") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 GatewayType))) ((:*:) (S1 (MetaSel (Just Symbol "_ccgPublicIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ccgBGPASN") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))
type Rs CreateCustomerGateway # 

Request Lenses

ccgDryRun :: Lens' CreateCustomerGateway (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 .

ccgType :: Lens' CreateCustomerGateway GatewayType #

The type of VPN connection that this customer gateway supports (ipsec.1 ).

ccgPublicIP :: Lens' CreateCustomerGateway Text #

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

ccgBGPASN :: Lens' CreateCustomerGateway Int #

For devices that support BGP, the customer gateway's BGP ASN. Default: 65000

Destructuring the Response

createCustomerGatewayResponse #

Creates a value of CreateCustomerGatewayResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateCustomerGatewayResponse #

Contains the output of CreateCustomerGateway.

See: createCustomerGatewayResponse smart constructor.

Instances

Eq CreateCustomerGatewayResponse # 
Data CreateCustomerGatewayResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateCustomerGatewayResponse -> c CreateCustomerGatewayResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateCustomerGatewayResponse #

toConstr :: CreateCustomerGatewayResponse -> Constr #

dataTypeOf :: CreateCustomerGatewayResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateCustomerGatewayResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateCustomerGatewayResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateCustomerGatewayResponse -> CreateCustomerGatewayResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateCustomerGatewayResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateCustomerGatewayResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateCustomerGatewayResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateCustomerGatewayResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateCustomerGatewayResponse -> m CreateCustomerGatewayResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCustomerGatewayResponse -> m CreateCustomerGatewayResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateCustomerGatewayResponse -> m CreateCustomerGatewayResponse #

Read CreateCustomerGatewayResponse # 
Show CreateCustomerGatewayResponse # 
Generic CreateCustomerGatewayResponse # 
NFData CreateCustomerGatewayResponse # 
type Rep CreateCustomerGatewayResponse # 
type Rep CreateCustomerGatewayResponse = D1 (MetaData "CreateCustomerGatewayResponse" "Network.AWS.EC2.CreateCustomerGateway" "amazonka-ec2-1.4.5-C4CR35JggG2GhWFrIiKGhu" False) (C1 (MetaCons "CreateCustomerGatewayResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ccgrsCustomerGateway") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CustomerGateway))) (S1 (MetaSel (Just Symbol "_ccgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses