amazonka-directconnect-1.6.0: 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.UpdateLag

Contents

Description

Updates the attributes of a link aggregation group (LAG).

You can update the following attributes:

  • The name of the LAG.
  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value, and the number of operational connections falls below the specified value, the LAG will automatically go down to avoid overutilization of the remaining connections. Adjusting this value should be done with care as it could force the LAG down if the value is set higher than the current number of operational connections.

Synopsis

Creating a Request

updateLag #

Arguments

:: Text

ulLagId

-> UpdateLag 

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

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

  • ulMinimumLinks - The minimum number of physical connections that must be operational for the LAG itself to be operational. Default: None
  • ulLagName - The name for the LAG. Example: "3x10G LAG to AWS " Default: None
  • ulLagId - The ID of the LAG to update. Example: dxlag-abc123 Default: None

data UpdateLag #

Container for the parameters to the UpdateLag operation.

See: updateLag smart constructor.

Instances

Eq UpdateLag # 
Data UpdateLag # 

Methods

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

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

toConstr :: UpdateLag -> Constr #

dataTypeOf :: UpdateLag -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateLag # 
Show UpdateLag # 
Generic UpdateLag # 

Associated Types

type Rep UpdateLag :: * -> * #

Hashable UpdateLag # 
ToJSON UpdateLag # 
NFData UpdateLag # 

Methods

rnf :: UpdateLag -> () #

AWSRequest UpdateLag # 
ToHeaders UpdateLag # 

Methods

toHeaders :: UpdateLag -> [Header] #

ToPath UpdateLag # 
ToQuery UpdateLag # 
type Rep UpdateLag # 
type Rep UpdateLag = D1 * (MetaData "UpdateLag" "Network.AWS.DirectConnect.UpdateLag" "amazonka-directconnect-1.6.0-1iHBIYuuv8NGkO6PD7WukU" False) (C1 * (MetaCons "UpdateLag'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ulMinimumLinks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ulLagName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ulLagId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs UpdateLag # 

Request Lenses

ulMinimumLinks :: Lens' UpdateLag (Maybe Int) #

The minimum number of physical connections that must be operational for the LAG itself to be operational. Default: None

ulLagName :: Lens' UpdateLag (Maybe Text) #

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

ulLagId :: Lens' UpdateLag Text #

The ID of the LAG to update. Example: dxlag-abc123 Default: None

Destructuring the Response

lag :: Lag #

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 #

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 # 

Methods

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

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

Data Lag # 

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 # 
Show Lag # 

Methods

showsPrec :: Int -> Lag -> ShowS #

show :: Lag -> String #

showList :: [Lag] -> ShowS #

Generic Lag # 

Associated Types

type Rep Lag :: * -> * #

Methods

from :: Lag -> Rep Lag x #

to :: Rep Lag x -> Lag #

Hashable Lag # 

Methods

hashWithSalt :: Int -> Lag -> Int #

hash :: Lag -> Int #

FromJSON Lag # 
NFData Lag # 

Methods

rnf :: Lag -> () #

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

Response Lenses

lagLagId :: Lens' Lag (Maybe Text) #

Undocumented member.

lagConnectionsBandwidth :: Lens' Lag (Maybe Text) #

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

lagMinimumLinks :: Lens' Lag (Maybe Int) #

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) #

The name of the LAG.

lagLocation :: Lens' Lag (Maybe Text) #

Undocumented member.

lagConnections :: Lens' Lag [Connection] #

A list of connections bundled by this LAG.

lagAwsDevice :: Lens' Lag (Maybe Text) #

The AWS Direct Connection endpoint that hosts the LAG.

lagAllowsHostedConnections :: Lens' Lag (Maybe Bool) #

Indicates whether the LAG can host other connections.

lagNumberOfConnections :: Lens' Lag (Maybe Int) #

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

lagLagState :: Lens' Lag (Maybe LagState) #

Undocumented member.

lagOwnerAccount :: Lens' Lag (Maybe Text) #

The owner of the LAG.

lagRegion :: Lens' Lag (Maybe Text) #

Undocumented member.