amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeVpnConnections

Description

Describes one or more of your VPN connections.

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

Synopsis

Creating a Request

data DescribeVpnConnections Source #

Contains the parameters for DescribeVpnConnections.

See: newDescribeVpnConnections smart constructor.

Constructors

DescribeVpnConnections' 

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.

  • filters :: Maybe [Filter]

    One or more filters.

    • customer-gateway-configuration - The configuration information for the customer gateway.
    • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
    • state - The state of the VPN connection (pending | available | deleting | deleted).
    • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
    • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
    • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
    • type - The type of VPN connection. Currently the only supported type is ipsec.1.
    • vpn-connection-id - The ID of the VPN connection.
    • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
    • transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
  • vpnConnectionIds :: Maybe [Text]

    One or more VPN connection IDs.

    Default: Describes your VPN connections.

Instances

Instances details
ToHeaders DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

toHeaders :: DescribeVpnConnections -> [Header] #

ToPath DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

toPath :: DescribeVpnConnections -> ByteString #

ToQuery DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

toQuery :: DescribeVpnConnections -> QueryString #

AWSRequest DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Associated Types

type AWSResponse DescribeVpnConnections #

Methods

request :: (Service -> Service) -> DescribeVpnConnections -> Request DescribeVpnConnections #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeVpnConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeVpnConnections))) #

Generic DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Associated Types

type Rep DescribeVpnConnections :: Type -> Type #

Methods

from :: DescribeVpnConnections -> Rep DescribeVpnConnections x #

to :: Rep DescribeVpnConnections x -> DescribeVpnConnections #

Read DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

readsPrec :: Int -> ReadS DescribeVpnConnections #

readList :: ReadS [DescribeVpnConnections] #

readPrec :: ReadPrec DescribeVpnConnections #

readListPrec :: ReadPrec [DescribeVpnConnections] #

Show DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

showsPrec :: Int -> DescribeVpnConnections -> ShowS #

show :: DescribeVpnConnections -> String #

showList :: [DescribeVpnConnections] -> ShowS #

NFData DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

rnf :: DescribeVpnConnections -> () #

Eq DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

(==) :: DescribeVpnConnections -> DescribeVpnConnections -> Bool #

(/=) :: DescribeVpnConnections -> DescribeVpnConnections -> Bool #

Hashable DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

hashWithSalt :: Int -> DescribeVpnConnections -> Int #

hash :: DescribeVpnConnections -> Int #

type AWSResponse DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

type AWSResponse DescribeVpnConnections = DescribeVpnConnectionsResponse
type Rep DescribeVpnConnections Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

type Rep DescribeVpnConnections = D1 ('MetaData "DescribeVpnConnections" "Amazonka.EC2.DescribeVpnConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpnConnections'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "vpnConnectionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeVpnConnections :: DescribeVpnConnections Source #

Create a value of DescribeVpnConnections 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:DescribeVpnConnections', describeVpnConnections_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:filters:DescribeVpnConnections', describeVpnConnections_filters - One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.
  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
  • state - The state of the VPN connection (pending | available | deleting | deleted).
  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • type - The type of VPN connection. Currently the only supported type is ipsec.1.
  • vpn-connection-id - The ID of the VPN connection.
  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
  • transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

$sel:vpnConnectionIds:DescribeVpnConnections', describeVpnConnections_vpnConnectionIds - One or more VPN connection IDs.

Default: Describes your VPN connections.

Request Lenses

describeVpnConnections_dryRun :: Lens' DescribeVpnConnections (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.

describeVpnConnections_filters :: Lens' DescribeVpnConnections (Maybe [Filter]) Source #

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.
  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
  • state - The state of the VPN connection (pending | available | deleting | deleted).
  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
  • type - The type of VPN connection. Currently the only supported type is ipsec.1.
  • vpn-connection-id - The ID of the VPN connection.
  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
  • transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

describeVpnConnections_vpnConnectionIds :: Lens' DescribeVpnConnections (Maybe [Text]) Source #

One or more VPN connection IDs.

Default: Describes your VPN connections.

Destructuring the Response

data DescribeVpnConnectionsResponse Source #

Contains the output of DescribeVpnConnections.

See: newDescribeVpnConnectionsResponse smart constructor.

Constructors

DescribeVpnConnectionsResponse' 

Fields

Instances

Instances details
Generic DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Associated Types

type Rep DescribeVpnConnectionsResponse :: Type -> Type #

Methods

from :: DescribeVpnConnectionsResponse -> Rep DescribeVpnConnectionsResponse x #

to :: Rep DescribeVpnConnectionsResponse x -> DescribeVpnConnectionsResponse #

Read DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

readsPrec :: Int -> ReadS DescribeVpnConnectionsResponse #

readList :: ReadS [DescribeVpnConnectionsResponse] #

readPrec :: ReadPrec DescribeVpnConnectionsResponse #

readListPrec :: ReadPrec [DescribeVpnConnectionsResponse] #

Show DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

showsPrec :: Int -> DescribeVpnConnectionsResponse -> ShowS #

show :: DescribeVpnConnectionsResponse -> String #

showList :: [DescribeVpnConnectionsResponse] -> ShowS #

NFData DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

rnf :: DescribeVpnConnectionsResponse -> () #

Eq DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

Methods

(==) :: DescribeVpnConnectionsResponse -> DescribeVpnConnectionsResponse -> Bool #

(/=) :: DescribeVpnConnectionsResponse -> DescribeVpnConnectionsResponse -> Bool #

type Rep DescribeVpnConnectionsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeVpnConnections

type Rep DescribeVpnConnectionsResponse = D1 ('MetaData "DescribeVpnConnectionsResponse" "Amazonka.EC2.DescribeVpnConnections" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeVpnConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpnConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpnConnection])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeVpnConnectionsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeVpnConnectionsResponse'

-> DescribeVpnConnectionsResponse 

Create a value of DescribeVpnConnectionsResponse 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:vpnConnections:DescribeVpnConnectionsResponse', describeVpnConnectionsResponse_vpnConnections - Information about one or more VPN connections.

$sel:httpStatus:DescribeVpnConnectionsResponse', describeVpnConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

describeVpnConnectionsResponse_vpnConnections :: Lens' DescribeVpnConnectionsResponse (Maybe [VpnConnection]) Source #

Information about one or more VPN connections.

describeVpnConnectionsResponse_httpStatus :: Lens' DescribeVpnConnectionsResponse Int Source #

The response's http status code.