Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.EC2.CreateCustomerGateway

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 AWS Managed VPN Connections 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.

Creating a Request

createCustomerGateway #

Arguments

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

data CreateCustomerGateway #

Contains the parameters for CreateCustomerGateway.

See: createCustomerGateway smart constructor.

Instances

Eq CreateCustomerGateway #
Methods (==) :: CreateCustomerGateway -> CreateCustomerGateway -> Bool # (/=) :: CreateCustomerGateway -> CreateCustomerGateway -> Bool #
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 #
Methods readsPrec :: Int -> ReadS CreateCustomerGateway # readList :: ReadS [CreateCustomerGateway] # readPrec :: ReadPrec CreateCustomerGateway # readListPrec :: ReadPrec [CreateCustomerGateway] #
Show CreateCustomerGateway #
Methods showsPrec :: Int -> CreateCustomerGateway -> ShowS # show :: CreateCustomerGateway -> String # showList :: [CreateCustomerGateway] -> ShowS #
Generic CreateCustomerGateway #
Associated Types type Rep CreateCustomerGateway :: * -> * # Methods from :: CreateCustomerGateway -> Rep CreateCustomerGateway x # to :: Rep CreateCustomerGateway x -> CreateCustomerGateway #
Hashable CreateCustomerGateway #
Methods hashWithSalt :: Int -> CreateCustomerGateway -> Int # hash :: CreateCustomerGateway -> Int #
NFData CreateCustomerGateway #
Methods rnf :: CreateCustomerGateway -> () #
AWSRequest CreateCustomerGateway #
Associated Types type Rs CreateCustomerGateway :: * # Methods request :: CreateCustomerGateway -> Request CreateCustomerGateway # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateCustomerGateway -> ClientResponse -> m (Response CreateCustomerGateway) #
ToHeaders CreateCustomerGateway #
Methods toHeaders :: CreateCustomerGateway -> [Header] #
ToPath CreateCustomerGateway #
Methods toPath :: CreateCustomerGateway -> ByteString #
ToQuery CreateCustomerGateway #
Methods toQuery :: CreateCustomerGateway -> QueryString #
type Rep CreateCustomerGateway #
type Rep CreateCustomerGateway = D1 * (MetaData "CreateCustomerGateway" "Network.AWS.EC2.CreateCustomerGateway" "amazonka-ec2-1.6.0-Dm9BQRbqSOK72xbfLZMG4m" False) (C1 * (MetaCons "CreateCustomerGateway'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_ccgDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ccgBGPASN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))) ((::) (S1 * (MetaSel (Just Symbol "_ccgPublicIP") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_ccgType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * GatewayType)))))
type Rs CreateCustomerGateway #
type Rs CreateCustomerGateway = CreateCustomerGatewayResponse

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 .

ccgBGPASN :: Lens' CreateCustomerGateway Int #

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

ccgPublicIP :: Lens' CreateCustomerGateway Text #

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

ccgType :: Lens' CreateCustomerGateway GatewayType #

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

Destructuring the Response

createCustomerGatewayResponse #

Arguments

:: Int	`ccgrsResponseStatus`
-> 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:

ccgrsCustomerGateway - Information about the customer gateway.
ccgrsResponseStatus - -- | The response status code.

data CreateCustomerGatewayResponse #

Contains the output of CreateCustomerGateway.

See: createCustomerGatewayResponse smart constructor.

Instances

Eq CreateCustomerGatewayResponse #
Methods (==) :: CreateCustomerGatewayResponse -> CreateCustomerGatewayResponse -> Bool # (/=) :: CreateCustomerGatewayResponse -> CreateCustomerGatewayResponse -> Bool #
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 #
Methods readsPrec :: Int -> ReadS CreateCustomerGatewayResponse # readList :: ReadS [CreateCustomerGatewayResponse] # readPrec :: ReadPrec CreateCustomerGatewayResponse # readListPrec :: ReadPrec [CreateCustomerGatewayResponse] #
Show CreateCustomerGatewayResponse #
Methods showsPrec :: Int -> CreateCustomerGatewayResponse -> ShowS # show :: CreateCustomerGatewayResponse -> String # showList :: [CreateCustomerGatewayResponse] -> ShowS #
Generic CreateCustomerGatewayResponse #
Associated Types type Rep CreateCustomerGatewayResponse :: * -> * # Methods from :: CreateCustomerGatewayResponse -> Rep CreateCustomerGatewayResponse x # to :: Rep CreateCustomerGatewayResponse x -> CreateCustomerGatewayResponse #
NFData CreateCustomerGatewayResponse #
Methods rnf :: CreateCustomerGatewayResponse -> () #
type Rep CreateCustomerGatewayResponse #
type Rep CreateCustomerGatewayResponse = D1 * (MetaData "CreateCustomerGatewayResponse" "Network.AWS.EC2.CreateCustomerGateway" "amazonka-ec2-1.6.0-Dm9BQRbqSOK72xbfLZMG4m" False) (C1 * (MetaCons "CreateCustomerGatewayResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ccgrsCustomerGateway") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe CustomerGateway))) (S1 * (MetaSel (Just Symbol "_ccgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ccgrsCustomerGateway :: Lens' CreateCustomerGatewayResponse (Maybe CustomerGateway) #

Information about the customer gateway.

ccgrsResponseStatus :: Lens' CreateCustomerGatewayResponse Int #

- | The response status code.