Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeInterconnects
- DeleteConnection
- CreateConnection
- DescribeConnections
- DescribeConnectionsOnInterconnect
- DeleteInterconnect
- ConfirmPrivateVirtualInterface
- DescribeLocations
- CreatePublicVirtualInterface
- AllocatePrivateVirtualInterface
- ConfirmConnection
- ConfirmPublicVirtualInterface
- DescribeVirtualGateways
- DescribeVirtualInterfaces
- DeleteVirtualInterface
- CreatePrivateVirtualInterface
- AllocatePublicVirtualInterface
- AllocateConnectionOnInterconnect
- CreateInterconnect
- Types
AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon Elastic Compute Cloud (Amazon EC2) and Amazon Simple Storage Service (Amazon S3)) and to Amazon Virtual Private Cloud (Amazon VPC), bypassing Internet service providers in your network path. An AWS Direct Connect location provides access to AWS in the region it is associated with, as well as access to other US regions. For example, you can provision a single connection to any AWS Direct Connect location in the US and use it to access public AWS services in all US Regions and AWS GovCloud (US).
- directConnect :: Service
- _DirectConnectClientException :: AsError a => Getting (First ServiceError) a ServiceError
- _DirectConnectServerException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.DirectConnect.DescribeInterconnects
- module Network.AWS.DirectConnect.DeleteConnection
- module Network.AWS.DirectConnect.CreateConnection
- module Network.AWS.DirectConnect.DescribeConnections
- module Network.AWS.DirectConnect.DescribeConnectionsOnInterconnect
- module Network.AWS.DirectConnect.DeleteInterconnect
- module Network.AWS.DirectConnect.ConfirmPrivateVirtualInterface
- module Network.AWS.DirectConnect.DescribeLocations
- module Network.AWS.DirectConnect.CreatePublicVirtualInterface
- module Network.AWS.DirectConnect.AllocatePrivateVirtualInterface
- module Network.AWS.DirectConnect.ConfirmConnection
- module Network.AWS.DirectConnect.ConfirmPublicVirtualInterface
- module Network.AWS.DirectConnect.DescribeVirtualGateways
- module Network.AWS.DirectConnect.DescribeVirtualInterfaces
- module Network.AWS.DirectConnect.DeleteVirtualInterface
- module Network.AWS.DirectConnect.CreatePrivateVirtualInterface
- module Network.AWS.DirectConnect.AllocatePublicVirtualInterface
- module Network.AWS.DirectConnect.AllocateConnectionOnInterconnect
- module Network.AWS.DirectConnect.CreateInterconnect
- data ConnectionState
- data InterconnectState
- data VirtualInterfaceState
- data Connection
- connection :: Connection
- cVlan :: Lens' Connection (Maybe Int)
- cLocation :: Lens' Connection (Maybe Text)
- cConnectionId :: Lens' Connection (Maybe Text)
- cPartnerName :: Lens' Connection (Maybe Text)
- cConnectionName :: Lens' Connection (Maybe Text)
- cBandwidth :: Lens' Connection (Maybe Text)
- cOwnerAccount :: Lens' Connection (Maybe Text)
- cRegion :: Lens' Connection (Maybe Text)
- cConnectionState :: Lens' Connection (Maybe ConnectionState)
- data Connections
- connections :: Connections
- cConnections :: Lens' Connections [Connection]
- data Interconnect
- interconnect :: Interconnect
- iInterconnectId :: Lens' Interconnect (Maybe Text)
- iLocation :: Lens' Interconnect (Maybe Text)
- iInterconnectName :: Lens' Interconnect (Maybe Text)
- iBandwidth :: Lens' Interconnect (Maybe Text)
- iInterconnectState :: Lens' Interconnect (Maybe InterconnectState)
- iRegion :: Lens' Interconnect (Maybe Text)
- data Location
- location :: Location
- lLocationName :: Lens' Location (Maybe Text)
- lLocationCode :: Lens' Location (Maybe Text)
- data NewPrivateVirtualInterface
- newPrivateVirtualInterface :: Text -> Int -> Int -> Text -> NewPrivateVirtualInterface
- nCustomerAddress :: Lens' NewPrivateVirtualInterface (Maybe Text)
- nAmazonAddress :: Lens' NewPrivateVirtualInterface (Maybe Text)
- nAuthKey :: Lens' NewPrivateVirtualInterface (Maybe Text)
- nVirtualInterfaceName :: Lens' NewPrivateVirtualInterface Text
- nVlan :: Lens' NewPrivateVirtualInterface Int
- nAsn :: Lens' NewPrivateVirtualInterface Int
- nVirtualGatewayId :: Lens' NewPrivateVirtualInterface Text
- data NewPrivateVirtualInterfaceAllocation
- newPrivateVirtualInterfaceAllocation :: Text -> Int -> Int -> NewPrivateVirtualInterfaceAllocation
- npviaCustomerAddress :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text)
- npviaAmazonAddress :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text)
- npviaAuthKey :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text)
- npviaVirtualInterfaceName :: Lens' NewPrivateVirtualInterfaceAllocation Text
- npviaVlan :: Lens' NewPrivateVirtualInterfaceAllocation Int
- npviaAsn :: Lens' NewPrivateVirtualInterfaceAllocation Int
- data NewPublicVirtualInterface
- newPublicVirtualInterface :: Text -> Int -> Int -> Text -> Text -> NewPublicVirtualInterface
- npviAuthKey :: Lens' NewPublicVirtualInterface (Maybe Text)
- npviVirtualInterfaceName :: Lens' NewPublicVirtualInterface Text
- npviVlan :: Lens' NewPublicVirtualInterface Int
- npviAsn :: Lens' NewPublicVirtualInterface Int
- npviAmazonAddress :: Lens' NewPublicVirtualInterface Text
- npviCustomerAddress :: Lens' NewPublicVirtualInterface Text
- npviRouteFilterPrefixes :: Lens' NewPublicVirtualInterface [RouteFilterPrefix]
- data NewPublicVirtualInterfaceAllocation
- newPublicVirtualInterfaceAllocation :: Text -> Int -> Int -> Text -> Text -> NewPublicVirtualInterfaceAllocation
- newAuthKey :: Lens' NewPublicVirtualInterfaceAllocation (Maybe Text)
- newVirtualInterfaceName :: Lens' NewPublicVirtualInterfaceAllocation Text
- newVlan :: Lens' NewPublicVirtualInterfaceAllocation Int
- newAsn :: Lens' NewPublicVirtualInterfaceAllocation Int
- newAmazonAddress :: Lens' NewPublicVirtualInterfaceAllocation Text
- newCustomerAddress :: Lens' NewPublicVirtualInterfaceAllocation Text
- newRouteFilterPrefixes :: Lens' NewPublicVirtualInterfaceAllocation [RouteFilterPrefix]
- data RouteFilterPrefix
- routeFilterPrefix :: RouteFilterPrefix
- rfpCidr :: Lens' RouteFilterPrefix (Maybe Text)
- data VirtualGateway
- virtualGateway :: VirtualGateway
- vgVirtualGatewayId :: Lens' VirtualGateway (Maybe Text)
- vgVirtualGatewayState :: Lens' VirtualGateway (Maybe Text)
- data VirtualInterface
- virtualInterface :: VirtualInterface
- viVirtualGatewayId :: Lens' VirtualInterface (Maybe Text)
- viRouteFilterPrefixes :: Lens' VirtualInterface [RouteFilterPrefix]
- viCustomerAddress :: Lens' VirtualInterface (Maybe Text)
- viVlan :: Lens' VirtualInterface (Maybe Int)
- viLocation :: Lens' VirtualInterface (Maybe Text)
- viAmazonAddress :: Lens' VirtualInterface (Maybe Text)
- viVirtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState)
- viConnectionId :: Lens' VirtualInterface (Maybe Text)
- viVirtualInterfaceType :: Lens' VirtualInterface (Maybe Text)
- viAsn :: Lens' VirtualInterface (Maybe Int)
- viAuthKey :: Lens' VirtualInterface (Maybe Text)
- viCustomerRouterConfig :: Lens' VirtualInterface (Maybe Text)
- viOwnerAccount :: Lens' VirtualInterface (Maybe Text)
- viVirtualInterfaceName :: Lens' VirtualInterface (Maybe Text)
- viVirtualInterfaceId :: Lens' VirtualInterface (Maybe Text)
Service Configuration
directConnect :: Service Source #
API version '2012-10-25' of the Amazon Direct Connect SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DirectConnect
.
DirectConnectClientException
_DirectConnectClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The API was called with invalid parameters. The error message will contain additional details about the cause.
DirectConnectServerException
_DirectConnectServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A server-side error occurred during the API call. The error message will contain additional details about the cause.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeInterconnects
DeleteConnection
CreateConnection
DescribeConnections
DescribeConnectionsOnInterconnect
DeleteInterconnect
ConfirmPrivateVirtualInterface
DescribeLocations
CreatePublicVirtualInterface
AllocatePrivateVirtualInterface
ConfirmConnection
ConfirmPublicVirtualInterface
DescribeVirtualGateways
DescribeVirtualInterfaces
DeleteVirtualInterface
CreatePrivateVirtualInterface
AllocatePublicVirtualInterface
AllocateConnectionOnInterconnect
CreateInterconnect
Types
ConnectionState
data ConnectionState Source #
State of the connection.
- Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
- Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
- Pending: The connection has been approved, and is being initialized.
- Available: The network link is up, and the connection is ready for use.
- Down: The network link is down.
- Deleting: The connection is in the process of being deleted.
- Deleted: The connection has been deleted.
- Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.
InterconnectState
data InterconnectState Source #
State of the interconnect.
- Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
- Pending: The interconnect has been approved, and is being initialized.
- Available: The network link is up, and the interconnect is ready for use.
- Down: The network link is down.
- Deleting: The interconnect is in the process of being deleted.
- Deleted: The interconnect has been deleted.
VirtualInterfaceState
data VirtualInterfaceState Source #
State of the virtual interface.
- Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
- Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
- Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
- Available: A virtual interface that is able to forward traffic.
- Down: A virtual interface that is BGP down.
- Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
- Deleted: A virtual interface that cannot forward traffic.
- Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
Connection
data Connection Source #
A connection represents the physical network connection between the AWS Direct Connect location and the customer.
See: connection
smart constructor.
connection :: Connection Source #
Creates a value of Connection
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cConnectionId :: Lens' Connection (Maybe Text) Source #
Undocumented member.
cPartnerName :: Lens' Connection (Maybe Text) Source #
Undocumented member.
cConnectionName :: Lens' Connection (Maybe Text) Source #
Undocumented member.
cBandwidth :: Lens' Connection (Maybe Text) Source #
Bandwidth of the connection.
Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
Default: None
cOwnerAccount :: Lens' Connection (Maybe Text) Source #
Undocumented member.
cConnectionState :: Lens' Connection (Maybe ConnectionState) Source #
Undocumented member.
Connections
data Connections Source #
A structure containing a list of connections.
See: connections
smart constructor.
connections :: Connections Source #
Creates a value of Connections
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cConnections :: Lens' Connections [Connection] Source #
A list of connections.
Interconnect
data Interconnect Source #
An interconnect is a connection that can host other connections.
Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.
The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.
See: interconnect
smart constructor.
interconnect :: Interconnect Source #
Creates a value of Interconnect
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iInterconnectId :: Lens' Interconnect (Maybe Text) Source #
Undocumented member.
iInterconnectName :: Lens' Interconnect (Maybe Text) Source #
Undocumented member.
iBandwidth :: Lens' Interconnect (Maybe Text) Source #
Undocumented member.
iInterconnectState :: Lens' Interconnect (Maybe InterconnectState) Source #
Undocumented member.
Location
An AWS Direct Connect location where connections and interconnects can be requested.
See: location
smart constructor.
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lLocationName :: Lens' Location (Maybe Text) Source #
The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.
lLocationCode :: Lens' Location (Maybe Text) Source #
The code used to indicate the AWS Direct Connect location.
NewPrivateVirtualInterface
data NewPrivateVirtualInterface Source #
A structure containing information about a new private virtual interface.
See: newPrivateVirtualInterface
smart constructor.
newPrivateVirtualInterface Source #
:: Text | |
-> Int | |
-> Int | |
-> Text | |
-> NewPrivateVirtualInterface |
Creates a value of NewPrivateVirtualInterface
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nCustomerAddress :: Lens' NewPrivateVirtualInterface (Maybe Text) Source #
Undocumented member.
nAmazonAddress :: Lens' NewPrivateVirtualInterface (Maybe Text) Source #
Undocumented member.
nVirtualInterfaceName :: Lens' NewPrivateVirtualInterface Text Source #
Undocumented member.
nVirtualGatewayId :: Lens' NewPrivateVirtualInterface Text Source #
Undocumented member.
NewPrivateVirtualInterfaceAllocation
data NewPrivateVirtualInterfaceAllocation Source #
A structure containing information about a private virtual interface that will be provisioned on a connection.
See: newPrivateVirtualInterfaceAllocation
smart constructor.
newPrivateVirtualInterfaceAllocation Source #
:: Text | |
-> Int | |
-> Int | |
-> NewPrivateVirtualInterfaceAllocation |
Creates a value of NewPrivateVirtualInterfaceAllocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
npviaCustomerAddress :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text) Source #
Undocumented member.
npviaAmazonAddress :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text) Source #
Undocumented member.
npviaAuthKey :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Text) Source #
Undocumented member.
npviaVirtualInterfaceName :: Lens' NewPrivateVirtualInterfaceAllocation Text Source #
Undocumented member.
NewPublicVirtualInterface
data NewPublicVirtualInterface Source #
A structure containing information about a new public virtual interface.
See: newPublicVirtualInterface
smart constructor.
newPublicVirtualInterface Source #
Creates a value of NewPublicVirtualInterface
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
npviAuthKey :: Lens' NewPublicVirtualInterface (Maybe Text) Source #
Undocumented member.
npviVirtualInterfaceName :: Lens' NewPublicVirtualInterface Text Source #
Undocumented member.
npviAmazonAddress :: Lens' NewPublicVirtualInterface Text Source #
Undocumented member.
npviCustomerAddress :: Lens' NewPublicVirtualInterface Text Source #
Undocumented member.
npviRouteFilterPrefixes :: Lens' NewPublicVirtualInterface [RouteFilterPrefix] Source #
Undocumented member.
NewPublicVirtualInterfaceAllocation
data NewPublicVirtualInterfaceAllocation Source #
A structure containing information about a public virtual interface that will be provisioned on a connection.
See: newPublicVirtualInterfaceAllocation
smart constructor.
newPublicVirtualInterfaceAllocation Source #
Creates a value of NewPublicVirtualInterfaceAllocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
newAuthKey :: Lens' NewPublicVirtualInterfaceAllocation (Maybe Text) Source #
Undocumented member.
newVirtualInterfaceName :: Lens' NewPublicVirtualInterfaceAllocation Text Source #
Undocumented member.
newAmazonAddress :: Lens' NewPublicVirtualInterfaceAllocation Text Source #
Undocumented member.
newCustomerAddress :: Lens' NewPublicVirtualInterfaceAllocation Text Source #
Undocumented member.
newRouteFilterPrefixes :: Lens' NewPublicVirtualInterfaceAllocation [RouteFilterPrefix] Source #
Undocumented member.
RouteFilterPrefix
data RouteFilterPrefix Source #
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
See: routeFilterPrefix
smart constructor.
routeFilterPrefix :: RouteFilterPrefix Source #
Creates a value of RouteFilterPrefix
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rfpCidr :: Lens' RouteFilterPrefix (Maybe Text) Source #
CIDR notation for the advertised route. Multiple routes are separated by commas.
Example: 10.10.10.0/24,10.10.11.0/24
VirtualGateway
data VirtualGateway Source #
You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.
Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.
See: virtualGateway
smart constructor.
virtualGateway :: VirtualGateway Source #
Creates a value of VirtualGateway
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vgVirtualGatewayId :: Lens' VirtualGateway (Maybe Text) Source #
Undocumented member.
vgVirtualGatewayState :: Lens' VirtualGateway (Maybe Text) Source #
Undocumented member.
VirtualInterface
data VirtualInterface Source #
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
See: virtualInterface
smart constructor.
virtualInterface :: VirtualInterface Source #
Creates a value of VirtualInterface
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
viVirtualGatewayId :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viRouteFilterPrefixes :: Lens' VirtualInterface [RouteFilterPrefix] Source #
Undocumented member.
viCustomerAddress :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viLocation :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viAmazonAddress :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viVirtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState) Source #
Undocumented member.
viConnectionId :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viVirtualInterfaceType :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viCustomerRouterConfig :: Lens' VirtualInterface (Maybe Text) Source #
Information for generating the customer router configuration.
viOwnerAccount :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viVirtualInterfaceName :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.
viVirtualInterfaceId :: Lens' VirtualInterface (Maybe Text) Source #
Undocumented member.