Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 can't 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).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the 'us-east-1' region, and 9059, which is reserved in the 'eu-west-1' region.
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.
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.
See: AWS API Reference for CreateCustomerGateway.
- createCustomerGateway :: GatewayType -> Text -> Int -> CreateCustomerGateway
- data CreateCustomerGateway
- ccgDryRun :: Lens' CreateCustomerGateway (Maybe Bool)
- ccgType :: Lens' CreateCustomerGateway GatewayType
- ccgPublicIP :: Lens' CreateCustomerGateway Text
- ccgBGPASN :: Lens' CreateCustomerGateway Int
- createCustomerGatewayResponse :: Int -> CreateCustomerGatewayResponse
- data CreateCustomerGatewayResponse
- ccgrsCustomerGateway :: Lens' CreateCustomerGatewayResponse (Maybe CustomerGateway)
- ccgrsResponseStatus :: Lens' CreateCustomerGatewayResponse Int
Creating a Request
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:
data CreateCustomerGateway Source
See: createCustomerGateway
smart constructor.
Request Lenses
ccgDryRun :: Lens' CreateCustomerGateway (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
.
ccgType :: Lens' CreateCustomerGateway GatewayType Source
The type of VPN connection that this customer gateway supports ('ipsec.1').
ccgPublicIP :: Lens' CreateCustomerGateway Text Source
The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
ccgBGPASN :: Lens' CreateCustomerGateway Int Source
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
Destructuring the Response
createCustomerGatewayResponse Source
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 Source
See: createCustomerGatewayResponse
smart constructor.
Response Lenses
ccgrsCustomerGateway :: Lens' CreateCustomerGatewayResponse (Maybe CustomerGateway) Source
Information about the customer gateway.
ccgrsResponseStatus :: Lens' CreateCustomerGatewayResponse Int Source
The response status code.