amazonka-directconnect-1.6.1: Amazon Direct Connect SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectConnect.CreateLag

Contents

Description

Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

Synopsis

Creating a Request

createLag Source #

Creates a value of CreateLag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • clConnectionId - The ID of an existing connection to migrate to the LAG. Default: None
  • clNumberOfConnections - The number of physical connections initially provisioned and bundled by the LAG. Default: None
  • clLocation - The AWS Direct Connect location in which the LAG should be allocated. Example: EqSV5 Default: None
  • clConnectionsBandwidth - The bandwidth of the individual physical connections bundled by the LAG. Default: None Available values: 1Gbps, 10Gbps
  • clLagName - The name of the LAG. Example: "3x10G LAG to AWS " Default: None

data CreateLag Source #

Container for the parameters to the CreateLag operation.

See: createLag smart constructor.

Instances
Eq CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Data CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateLag -> c CreateLag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateLag #

toConstr :: CreateLag -> Constr #

dataTypeOf :: CreateLag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateLag) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateLag) #

gmapT :: (forall b. Data b => b -> b) -> CreateLag -> CreateLag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateLag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateLag -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateLag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateLag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateLag -> m CreateLag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLag -> m CreateLag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateLag -> m CreateLag #

Read CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Show CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Generic CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Associated Types

type Rep CreateLag :: Type -> Type #

Hashable CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

ToJSON CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

AWSRequest CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Associated Types

type Rs CreateLag :: Type #

ToHeaders CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Methods

toHeaders :: CreateLag -> [Header] #

ToPath CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

ToQuery CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

NFData CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Methods

rnf :: CreateLag -> () #

type Rep CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

type Rep CreateLag = D1 (MetaData "CreateLag" "Network.AWS.DirectConnect.CreateLag" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" False) (C1 (MetaCons "CreateLag'" PrefixI True) ((S1 (MetaSel (Just "_clConnectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clNumberOfConnections") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :*: (S1 (MetaSel (Just "_clLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_clConnectionsBandwidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_clLagName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateLag Source # 
Instance details

Defined in Network.AWS.DirectConnect.CreateLag

Request Lenses

clConnectionId :: Lens' CreateLag (Maybe Text) Source #

The ID of an existing connection to migrate to the LAG. Default: None

clNumberOfConnections :: Lens' CreateLag Int Source #

The number of physical connections initially provisioned and bundled by the LAG. Default: None

clLocation :: Lens' CreateLag Text Source #

The AWS Direct Connect location in which the LAG should be allocated. Example: EqSV5 Default: None

clConnectionsBandwidth :: Lens' CreateLag Text Source #

The bandwidth of the individual physical connections bundled by the LAG. Default: None Available values: 1Gbps, 10Gbps

clLagName :: Lens' CreateLag Text Source #

The name of the LAG. Example: "3x10G LAG to AWS " Default: None

Destructuring the Response

lag :: Lag Source #

Creates a value of Lag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lagLagId - Undocumented member.
  • lagConnectionsBandwidth - The individual bandwidth of the physical connections bundled by the LAG. Available values: 1Gbps, 10Gbps
  • lagMinimumLinks - The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.
  • lagLagName - The name of the LAG.
  • lagLocation - Undocumented member.
  • lagConnections - A list of connections bundled by this LAG.
  • lagAwsDevice - The AWS Direct Connection endpoint that hosts the LAG.
  • lagAllowsHostedConnections - Indicates whether the LAG can host other connections.
  • lagNumberOfConnections - The number of physical connections bundled by the LAG, up to a maximum of 10.
  • lagLagState - Undocumented member.
  • lagOwnerAccount - The owner of the LAG.
  • lagRegion - Undocumented member.

data Lag Source #

Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

See: lag smart constructor.

Instances
Eq Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

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

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

Data Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Lag -> c Lag #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Lag #

toConstr :: Lag -> Constr #

dataTypeOf :: Lag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Lag) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Lag) #

gmapT :: (forall b. Data b => b -> b) -> Lag -> Lag #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Lag -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Lag -> r #

gmapQ :: (forall d. Data d => d -> u) -> Lag -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Lag -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Lag -> m Lag #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Lag -> m Lag #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Lag -> m Lag #

Read Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Show Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

showsPrec :: Int -> Lag -> ShowS #

show :: Lag -> String #

showList :: [Lag] -> ShowS #

Generic Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Associated Types

type Rep Lag :: Type -> Type #

Methods

from :: Lag -> Rep Lag x #

to :: Rep Lag x -> Lag #

Hashable Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

hashWithSalt :: Int -> Lag -> Int #

hash :: Lag -> Int #

FromJSON Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

NFData Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

Methods

rnf :: Lag -> () #

type Rep Lag Source # 
Instance details

Defined in Network.AWS.DirectConnect.Types.Product

type Rep Lag = D1 (MetaData "Lag" "Network.AWS.DirectConnect.Types.Product" "amazonka-directconnect-1.6.1-Jjw4CKEcom3TDRFDWXGnu" False) (C1 (MetaCons "Lag'" PrefixI True) (((S1 (MetaSel (Just "_lagLagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lagConnectionsBandwidth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lagMinimumLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 (MetaSel (Just "_lagLagName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lagLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lagConnections") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Connection]))))) :*: ((S1 (MetaSel (Just "_lagAwsDevice") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_lagAllowsHostedConnections") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_lagNumberOfConnections") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 (MetaSel (Just "_lagLagState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LagState)) :*: (S1 (MetaSel (Just "_lagOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lagRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

Response Lenses

lagLagId :: Lens' Lag (Maybe Text) Source #

Undocumented member.

lagConnectionsBandwidth :: Lens' Lag (Maybe Text) Source #

The individual bandwidth of the physical connections bundled by the LAG. Available values: 1Gbps, 10Gbps

lagMinimumLinks :: Lens' Lag (Maybe Int) Source #

The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down . This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

lagLagName :: Lens' Lag (Maybe Text) Source #

The name of the LAG.

lagLocation :: Lens' Lag (Maybe Text) Source #

Undocumented member.

lagConnections :: Lens' Lag [Connection] Source #

A list of connections bundled by this LAG.

lagAwsDevice :: Lens' Lag (Maybe Text) Source #

The AWS Direct Connection endpoint that hosts the LAG.

lagAllowsHostedConnections :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG can host other connections.

lagNumberOfConnections :: Lens' Lag (Maybe Int) Source #

The number of physical connections bundled by the LAG, up to a maximum of 10.

lagLagState :: Lens' Lag (Maybe LagState) Source #

Undocumented member.

lagOwnerAccount :: Lens' Lag (Maybe Text) Source #

The owner of the LAG.

lagRegion :: Lens' Lag (Maybe Text) Source #

Undocumented member.