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.CreateCustomerGateway

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can 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. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway.

Synopsis

Creating a Request

data CreateCustomerGateway Source #

Contains the parameters for CreateCustomerGateway.

See: newCreateCustomerGateway smart constructor.

Constructors

CreateCustomerGateway'

Fields

certificateArn :: Maybe Text
The Amazon Resource Name (ARN) for the customer gateway certificate.
deviceName :: Maybe Text
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
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.
ipAddress :: Maybe Text
IPv4 address for the customer gateway device's outside interface. The address must be static.
publicIp :: Maybe Text
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the customer gateway.
bgpAsn :: Int
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
type' :: GatewayType
The type of VPN connection that this customer gateway supports (ipsec.1).

Instances

Instances details

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

newCreateCustomerGateway Source #

Arguments

:: Int	`CreateCustomerGateway`
-> GatewayType	`CreateCustomerGateway`
-> CreateCustomerGateway

Create a value of CreateCustomerGateway 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:

CreateCustomerGateway, createCustomerGateway_certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.

CreateCustomerGateway, createCustomerGateway_deviceName - A name for the customer gateway device.

Length Constraints: Up to 255 characters.

$sel:dryRun:CreateCustomerGateway', createCustomerGateway_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.

CreateCustomerGateway, createCustomerGateway_ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static.

CreateCustomerGateway, createCustomerGateway_publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

CreateCustomerGateway, createCustomerGateway_tagSpecifications - The tags to apply to the customer gateway.

CreateCustomerGateway, createCustomerGateway_bgpAsn - For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

CreateCustomerGateway, createCustomerGateway_type - The type of VPN connection that this customer gateway supports (ipsec.1).

Request Lenses

createCustomerGateway_certificateArn :: Lens' CreateCustomerGateway (Maybe Text) Source #

The Amazon Resource Name (ARN) for the customer gateway certificate.

createCustomerGateway_deviceName :: Lens' CreateCustomerGateway (Maybe Text) Source #

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

createCustomerGateway_dryRun :: 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.

createCustomerGateway_ipAddress :: Lens' CreateCustomerGateway (Maybe Text) Source #

IPv4 address for the customer gateway device's outside interface. The address must be static.

createCustomerGateway_publicIp :: Lens' CreateCustomerGateway (Maybe Text) Source #

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

createCustomerGateway_tagSpecifications :: Lens' CreateCustomerGateway (Maybe [TagSpecification]) Source #

The tags to apply to the customer gateway.

createCustomerGateway_bgpAsn :: Lens' CreateCustomerGateway Int Source #

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

Default: 65000

createCustomerGateway_type :: Lens' CreateCustomerGateway GatewayType Source #

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

Destructuring the Response

data CreateCustomerGatewayResponse Source #

Contains the output of CreateCustomerGateway.

See: newCreateCustomerGatewayResponse smart constructor.

Constructors

CreateCustomerGatewayResponse'
Fields customerGateway :: Maybe CustomerGateway Information about the customer gateway. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateCustomerGatewayResponse Source #

Arguments

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

Create a value of CreateCustomerGatewayResponse 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:

CreateCustomerGatewayResponse, createCustomerGatewayResponse_customerGateway - Information about the customer gateway.

$sel:httpStatus:CreateCustomerGatewayResponse', createCustomerGatewayResponse_httpStatus - The response's http status code.

Response Lenses

createCustomerGatewayResponse_customerGateway :: Lens' CreateCustomerGatewayResponse (Maybe CustomerGateway) Source #

Information about the customer gateway.

createCustomerGatewayResponse_httpStatus :: Lens' CreateCustomerGatewayResponse Int Source #

The response's http status code.