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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.

Synopsis

data GetVpnConnectionDeviceSampleConfiguration = GetVpnConnectionDeviceSampleConfiguration' {
- dryRun :: Maybe Bool
- internetKeyExchangeVersion :: Maybe Text
- vpnConnectionId :: Text
- vpnConnectionDeviceTypeId :: Text
}
newGetVpnConnectionDeviceSampleConfiguration :: Text -> Text -> GetVpnConnectionDeviceSampleConfiguration
getVpnConnectionDeviceSampleConfiguration_dryRun :: Lens' GetVpnConnectionDeviceSampleConfiguration (Maybe Bool)
getVpnConnectionDeviceSampleConfiguration_internetKeyExchangeVersion :: Lens' GetVpnConnectionDeviceSampleConfiguration (Maybe Text)
getVpnConnectionDeviceSampleConfiguration_vpnConnectionId :: Lens' GetVpnConnectionDeviceSampleConfiguration Text
getVpnConnectionDeviceSampleConfiguration_vpnConnectionDeviceTypeId :: Lens' GetVpnConnectionDeviceSampleConfiguration Text
data GetVpnConnectionDeviceSampleConfigurationResponse = GetVpnConnectionDeviceSampleConfigurationResponse' {
- vpnConnectionDeviceSampleConfiguration :: Maybe (Sensitive Text)
- httpStatus :: Int
}
newGetVpnConnectionDeviceSampleConfigurationResponse :: Int -> GetVpnConnectionDeviceSampleConfigurationResponse
getVpnConnectionDeviceSampleConfigurationResponse_vpnConnectionDeviceSampleConfiguration :: Lens' GetVpnConnectionDeviceSampleConfigurationResponse (Maybe Text)
getVpnConnectionDeviceSampleConfigurationResponse_httpStatus :: Lens' GetVpnConnectionDeviceSampleConfigurationResponse Int

Creating a Request

data GetVpnConnectionDeviceSampleConfiguration Source #

See: newGetVpnConnectionDeviceSampleConfiguration smart constructor.

Constructors

GetVpnConnectionDeviceSampleConfiguration'

Fields

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.
internetKeyExchangeVersion :: Maybe Text
The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.
vpnConnectionId :: Text
The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
vpnConnectionDeviceTypeId :: Text
Device identifier provided by the GetVpnConnectionDeviceTypes API.

Instances

Instances details

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

newGetVpnConnectionDeviceSampleConfiguration Source #

Arguments

:: Text	`GetVpnConnectionDeviceSampleConfiguration`
-> Text	`GetVpnConnectionDeviceSampleConfiguration`
-> GetVpnConnectionDeviceSampleConfiguration

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

$sel:dryRun:GetVpnConnectionDeviceSampleConfiguration', getVpnConnectionDeviceSampleConfiguration_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.

$sel:internetKeyExchangeVersion:GetVpnConnectionDeviceSampleConfiguration', getVpnConnectionDeviceSampleConfiguration_internetKeyExchangeVersion - The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.

GetVpnConnectionDeviceSampleConfiguration, getVpnConnectionDeviceSampleConfiguration_vpnConnectionId - The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

GetVpnConnectionDeviceSampleConfiguration, getVpnConnectionDeviceSampleConfiguration_vpnConnectionDeviceTypeId - Device identifier provided by the GetVpnConnectionDeviceTypes API.

Request Lenses

getVpnConnectionDeviceSampleConfiguration_dryRun :: Lens' GetVpnConnectionDeviceSampleConfiguration (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.

getVpnConnectionDeviceSampleConfiguration_internetKeyExchangeVersion :: Lens' GetVpnConnectionDeviceSampleConfiguration (Maybe Text) Source #

The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.

getVpnConnectionDeviceSampleConfiguration_vpnConnectionId :: Lens' GetVpnConnectionDeviceSampleConfiguration Text Source #

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

getVpnConnectionDeviceSampleConfiguration_vpnConnectionDeviceTypeId :: Lens' GetVpnConnectionDeviceSampleConfiguration Text Source #

Device identifier provided by the GetVpnConnectionDeviceTypes API.

Destructuring the Response

data GetVpnConnectionDeviceSampleConfigurationResponse Source #

See: newGetVpnConnectionDeviceSampleConfigurationResponse smart constructor.

Constructors

GetVpnConnectionDeviceSampleConfigurationResponse'
Fields vpnConnectionDeviceSampleConfiguration :: Maybe (Sensitive Text) Sample configuration file for the specified customer gateway device. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetVpnConnectionDeviceSampleConfigurationResponse Source #
Instance details Defined in Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration Associated Types type Rep GetVpnConnectionDeviceSampleConfigurationResponse :: Type -> Type # Methods from :: GetVpnConnectionDeviceSampleConfigurationResponse -> Rep GetVpnConnectionDeviceSampleConfigurationResponse x # to :: Rep GetVpnConnectionDeviceSampleConfigurationResponse x -> GetVpnConnectionDeviceSampleConfigurationResponse #
Show GetVpnConnectionDeviceSampleConfigurationResponse Source #
Instance details Defined in Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration Methods showsPrec :: Int -> GetVpnConnectionDeviceSampleConfigurationResponse -> ShowS # show :: GetVpnConnectionDeviceSampleConfigurationResponse -> String # showList :: [GetVpnConnectionDeviceSampleConfigurationResponse] -> ShowS #
NFData GetVpnConnectionDeviceSampleConfigurationResponse Source #
Instance details Defined in Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration Methods rnf :: GetVpnConnectionDeviceSampleConfigurationResponse -> () #
Eq GetVpnConnectionDeviceSampleConfigurationResponse Source #
Instance details Defined in Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration Methods (==) :: GetVpnConnectionDeviceSampleConfigurationResponse -> GetVpnConnectionDeviceSampleConfigurationResponse -> Bool # (/=) :: GetVpnConnectionDeviceSampleConfigurationResponse -> GetVpnConnectionDeviceSampleConfigurationResponse -> Bool #
type Rep GetVpnConnectionDeviceSampleConfigurationResponse Source #
Instance details Defined in Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration type Rep GetVpnConnectionDeviceSampleConfigurationResponse = D1 ('MetaData "GetVpnConnectionDeviceSampleConfigurationResponse" "Amazonka.EC2.GetVpnConnectionDeviceSampleConfiguration" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetVpnConnectionDeviceSampleConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpnConnectionDeviceSampleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetVpnConnectionDeviceSampleConfigurationResponse Source #

Arguments

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

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

$sel:vpnConnectionDeviceSampleConfiguration:GetVpnConnectionDeviceSampleConfigurationResponse', getVpnConnectionDeviceSampleConfigurationResponse_vpnConnectionDeviceSampleConfiguration - Sample configuration file for the specified customer gateway device.

$sel:httpStatus:GetVpnConnectionDeviceSampleConfigurationResponse', getVpnConnectionDeviceSampleConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getVpnConnectionDeviceSampleConfigurationResponse_vpnConnectionDeviceSampleConfiguration :: Lens' GetVpnConnectionDeviceSampleConfigurationResponse (Maybe Text) Source #

Sample configuration file for the specified customer gateway device.

getVpnConnectionDeviceSampleConfigurationResponse_httpStatus :: Lens' GetVpnConnectionDeviceSampleConfigurationResponse Int Source #

The response's http status code.