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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Synopsis

data CreateVpnGateway = CreateVpnGateway' {
- amazonSideAsn :: Maybe Integer
- availabilityZone :: Maybe Text
- dryRun :: Maybe Bool
- tagSpecifications :: Maybe [TagSpecification]
- type' :: GatewayType
}
newCreateVpnGateway :: GatewayType -> CreateVpnGateway
createVpnGateway_amazonSideAsn :: Lens' CreateVpnGateway (Maybe Integer)
createVpnGateway_availabilityZone :: Lens' CreateVpnGateway (Maybe Text)
createVpnGateway_dryRun :: Lens' CreateVpnGateway (Maybe Bool)
createVpnGateway_tagSpecifications :: Lens' CreateVpnGateway (Maybe [TagSpecification])
createVpnGateway_type :: Lens' CreateVpnGateway GatewayType
data CreateVpnGatewayResponse = CreateVpnGatewayResponse' {
- vpnGateway :: Maybe VpnGateway
- httpStatus :: Int
}
newCreateVpnGatewayResponse :: Int -> CreateVpnGatewayResponse
createVpnGatewayResponse_vpnGateway :: Lens' CreateVpnGatewayResponse (Maybe VpnGateway)
createVpnGatewayResponse_httpStatus :: Lens' CreateVpnGatewayResponse Int

Creating a Request

data CreateVpnGateway Source #

Contains the parameters for CreateVpnGateway.

See: newCreateVpnGateway smart constructor.

Constructors

CreateVpnGateway'

Fields

amazonSideAsn :: Maybe Integer
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
Default: 64512
availabilityZone :: Maybe Text
The Availability Zone for the virtual private gateway.
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.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the virtual private gateway.
type' :: GatewayType
The type of VPN connection this virtual private gateway supports.

Instances

Instances details

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

newCreateVpnGateway Source #

Arguments

:: GatewayType	`CreateVpnGateway`
-> CreateVpnGateway

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

CreateVpnGateway, createVpnGateway_amazonSideAsn - A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

CreateVpnGateway, createVpnGateway_availabilityZone - The Availability Zone for the virtual private gateway.

$sel:dryRun:CreateVpnGateway', createVpnGateway_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.

CreateVpnGateway, createVpnGateway_tagSpecifications - The tags to apply to the virtual private gateway.

CreateVpnGateway, createVpnGateway_type - The type of VPN connection this virtual private gateway supports.

Request Lenses

createVpnGateway_amazonSideAsn :: Lens' CreateVpnGateway (Maybe Integer) Source #

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

createVpnGateway_availabilityZone :: Lens' CreateVpnGateway (Maybe Text) Source #

The Availability Zone for the virtual private gateway.

createVpnGateway_dryRun :: Lens' CreateVpnGateway (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.

createVpnGateway_tagSpecifications :: Lens' CreateVpnGateway (Maybe [TagSpecification]) Source #

The tags to apply to the virtual private gateway.

createVpnGateway_type :: Lens' CreateVpnGateway GatewayType Source #

The type of VPN connection this virtual private gateway supports.

Destructuring the Response

data CreateVpnGatewayResponse Source #

Contains the output of CreateVpnGateway.

See: newCreateVpnGatewayResponse smart constructor.

Constructors

CreateVpnGatewayResponse'
Fields vpnGateway :: Maybe VpnGateway Information about the virtual private gateway. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateVpnGatewayResponse Source #

Arguments

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

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

CreateVpnGatewayResponse, createVpnGatewayResponse_vpnGateway - Information about the virtual private gateway.

$sel:httpStatus:CreateVpnGatewayResponse', createVpnGatewayResponse_httpStatus - The response's http status code.

Response Lenses

createVpnGatewayResponse_vpnGateway :: Lens' CreateVpnGatewayResponse (Maybe VpnGateway) Source #

Information about the virtual private gateway.

createVpnGatewayResponse_httpStatus :: Lens' CreateVpnGatewayResponse Int Source #

The response's http status code.