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.Types.VpnConnection

Description

Synopsis

data VpnConnection = VpnConnection' {
- category :: Maybe Text
- coreNetworkArn :: Maybe Text
- coreNetworkAttachmentArn :: Maybe Text
- customerGatewayConfiguration :: Maybe Text
- gatewayAssociationState :: Maybe GatewayAssociationState
- options :: Maybe VpnConnectionOptions
- routes :: Maybe [VpnStaticRoute]
- tags :: Maybe [Tag]
- transitGatewayId :: Maybe Text
- vgwTelemetry :: Maybe [VgwTelemetry]
- vpnGatewayId :: Maybe Text
- vpnConnectionId :: Text
- customerGatewayId :: Text
- state :: VpnState
- type' :: GatewayType
}
newVpnConnection :: Text -> Text -> VpnState -> GatewayType -> VpnConnection
vpnConnection_category :: Lens' VpnConnection (Maybe Text)
vpnConnection_coreNetworkArn :: Lens' VpnConnection (Maybe Text)
vpnConnection_coreNetworkAttachmentArn :: Lens' VpnConnection (Maybe Text)
vpnConnection_customerGatewayConfiguration :: Lens' VpnConnection (Maybe Text)
vpnConnection_gatewayAssociationState :: Lens' VpnConnection (Maybe GatewayAssociationState)
vpnConnection_options :: Lens' VpnConnection (Maybe VpnConnectionOptions)
vpnConnection_routes :: Lens' VpnConnection (Maybe [VpnStaticRoute])
vpnConnection_tags :: Lens' VpnConnection (Maybe [Tag])
vpnConnection_transitGatewayId :: Lens' VpnConnection (Maybe Text)
vpnConnection_vgwTelemetry :: Lens' VpnConnection (Maybe [VgwTelemetry])
vpnConnection_vpnGatewayId :: Lens' VpnConnection (Maybe Text)
vpnConnection_vpnConnectionId :: Lens' VpnConnection Text
vpnConnection_customerGatewayId :: Lens' VpnConnection Text
vpnConnection_state :: Lens' VpnConnection VpnState
vpnConnection_type :: Lens' VpnConnection GatewayType

Documentation

data VpnConnection Source #

Describes a VPN connection.

See: newVpnConnection smart constructor.

Constructors

VpnConnection'

Fields

category :: Maybe Text
The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
coreNetworkArn :: Maybe Text
The ARN of the core network.
coreNetworkAttachmentArn :: Maybe Text
The ARN of the core network attachment.
customerGatewayConfiguration :: Maybe Text
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.
gatewayAssociationState :: Maybe GatewayAssociationState
The current state of the gateway association.
options :: Maybe VpnConnectionOptions
The VPN connection options.
routes :: Maybe [VpnStaticRoute]
The static routes associated with the VPN connection.
tags :: Maybe [Tag]
Any tags assigned to the VPN connection.
transitGatewayId :: Maybe Text
The ID of the transit gateway associated with the VPN connection.
vgwTelemetry :: Maybe [VgwTelemetry]
Information about the VPN tunnel.
vpnGatewayId :: Maybe Text
The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
vpnConnectionId :: Text
The ID of the VPN connection.
customerGatewayId :: Text
The ID of the customer gateway at your end of the VPN connection.
state :: VpnState
The current state of the VPN connection.
type' :: GatewayType
The type of VPN connection.

Instances

Instances details

FromXML VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods parseXML :: [Node] -> Either String VpnConnection #
Generic VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Associated Types type Rep VpnConnection :: Type -> Type # Methods from :: VpnConnection -> Rep VpnConnection x # to :: Rep VpnConnection x -> VpnConnection #
Read VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods readsPrec :: Int -> ReadS VpnConnection # readList :: ReadS [VpnConnection] # readPrec :: ReadPrec VpnConnection # readListPrec :: ReadPrec [VpnConnection] #
Show VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods showsPrec :: Int -> VpnConnection -> ShowS # show :: VpnConnection -> String # showList :: [VpnConnection] -> ShowS #
NFData VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods rnf :: VpnConnection -> () #
Eq VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods (==) :: VpnConnection -> VpnConnection -> Bool # (/=) :: VpnConnection -> VpnConnection -> Bool #
Hashable VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection Methods hashWithSalt :: Int -> VpnConnection -> Int # hash :: VpnConnection -> Int #
type Rep VpnConnection Source #
Instance details Defined in Amazonka.EC2.Types.VpnConnection type Rep VpnConnection = D1 ('MetaData "VpnConnection" "Amazonka.EC2.Types.VpnConnection" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "VpnConnection'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "coreNetworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "coreNetworkAttachmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "customerGatewayConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gatewayAssociationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayAssociationState))) :: (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpnConnectionOptions)) :: S1 ('MetaSel ('Just "routes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpnStaticRoute]))))) :: (((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "transitGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vgwTelemetry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VgwTelemetry])) :: S1 ('MetaSel ('Just "vpnGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vpnConnectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "customerGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VpnState) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayType))))))

newVpnConnection Source #

Arguments

:: Text	`$sel:vpnConnectionId:VpnConnection'`
-> Text	`$sel:customerGatewayId:VpnConnection'`
-> VpnState	`VpnConnection`
-> GatewayType	`$sel:type':VpnConnection'`
-> VpnConnection

Create a value of VpnConnection 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:category:VpnConnection', vpnConnection_category - The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

$sel:coreNetworkArn:VpnConnection', vpnConnection_coreNetworkArn - The ARN of the core network.

$sel:coreNetworkAttachmentArn:VpnConnection', vpnConnection_coreNetworkAttachmentArn - The ARN of the core network attachment.

$sel:customerGatewayConfiguration:VpnConnection', vpnConnection_customerGatewayConfiguration - The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

$sel:gatewayAssociationState:VpnConnection', vpnConnection_gatewayAssociationState - The current state of the gateway association.

$sel:options:VpnConnection', vpnConnection_options - The VPN connection options.

$sel:routes:VpnConnection', vpnConnection_routes - The static routes associated with the VPN connection.

$sel:tags:VpnConnection', vpnConnection_tags - Any tags assigned to the VPN connection.

$sel:transitGatewayId:VpnConnection', vpnConnection_transitGatewayId - The ID of the transit gateway associated with the VPN connection.

$sel:vgwTelemetry:VpnConnection', vpnConnection_vgwTelemetry - Information about the VPN tunnel.

$sel:vpnGatewayId:VpnConnection', vpnConnection_vpnGatewayId - The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.

$sel:vpnConnectionId:VpnConnection', vpnConnection_vpnConnectionId - The ID of the VPN connection.

$sel:customerGatewayId:VpnConnection', vpnConnection_customerGatewayId - The ID of the customer gateway at your end of the VPN connection.

VpnConnection, vpnConnection_state - The current state of the VPN connection.

$sel:type':VpnConnection', vpnConnection_type - The type of VPN connection.

vpnConnection_category :: Lens' VpnConnection (Maybe Text) Source #

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

vpnConnection_coreNetworkArn :: Lens' VpnConnection (Maybe Text) Source #

The ARN of the core network.

vpnConnection_coreNetworkAttachmentArn :: Lens' VpnConnection (Maybe Text) Source #

The ARN of the core network attachment.

vpnConnection_customerGatewayConfiguration :: Lens' VpnConnection (Maybe Text) Source #

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

vpnConnection_gatewayAssociationState :: Lens' VpnConnection (Maybe GatewayAssociationState) Source #

The current state of the gateway association.

vpnConnection_options :: Lens' VpnConnection (Maybe VpnConnectionOptions) Source #

The VPN connection options.

vpnConnection_routes :: Lens' VpnConnection (Maybe [VpnStaticRoute]) Source #

The static routes associated with the VPN connection.

vpnConnection_tags :: Lens' VpnConnection (Maybe [Tag]) Source #

Any tags assigned to the VPN connection.

vpnConnection_transitGatewayId :: Lens' VpnConnection (Maybe Text) Source #

The ID of the transit gateway associated with the VPN connection.

vpnConnection_vgwTelemetry :: Lens' VpnConnection (Maybe [VgwTelemetry]) Source #

Information about the VPN tunnel.