Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DirectConnect.UpdateLag

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

You can update the following LAG 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.
The LAG's MACsec encryption mode.
Amazon Web Services assigns this value to each connection which is part of the LAG.
The tags

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

Synopsis

data UpdateLag = UpdateLag' {
- minimumLinks :: Maybe Int
- lagName :: Maybe Text
- encryptionMode :: Maybe Text
- lagId :: Text
}
newUpdateLag :: Text -> UpdateLag
updateLag_minimumLinks :: Lens' UpdateLag (Maybe Int)
updateLag_lagName :: Lens' UpdateLag (Maybe Text)
updateLag_encryptionMode :: Lens' UpdateLag (Maybe Text)
updateLag_lagId :: Lens' UpdateLag Text
data Lag = Lag' {
- lagId :: Maybe Text
- macSecCapable :: Maybe Bool
- connectionsBandwidth :: Maybe Text
- minimumLinks :: Maybe Int
- lagName :: Maybe Text
- location :: Maybe Text
- connections :: Maybe [Connection]
- awsDevice :: Maybe Text
- hasLogicalRedundancy :: Maybe HasLogicalRedundancy
- awsLogicalDeviceId :: Maybe Text
- allowsHostedConnections :: Maybe Bool
- encryptionMode :: Maybe Text
- numberOfConnections :: Maybe Int
- jumboFrameCapable :: Maybe Bool
- lagState :: Maybe LagState
- ownerAccount :: Maybe Text
- region :: Maybe Text
- macSecKeys :: Maybe [MacSecKey]
- providerName :: Maybe Text
- awsDeviceV2 :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
}
newLag :: Lag
lag_lagId :: Lens' Lag (Maybe Text)
lag_macSecCapable :: Lens' Lag (Maybe Bool)
lag_connectionsBandwidth :: Lens' Lag (Maybe Text)
lag_minimumLinks :: Lens' Lag (Maybe Int)
lag_lagName :: Lens' Lag (Maybe Text)
lag_location :: Lens' Lag (Maybe Text)
lag_connections :: Lens' Lag (Maybe [Connection])
lag_awsDevice :: Lens' Lag (Maybe Text)
lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy)
lag_awsLogicalDeviceId :: Lens' Lag (Maybe Text)
lag_allowsHostedConnections :: Lens' Lag (Maybe Bool)
lag_encryptionMode :: Lens' Lag (Maybe Text)
lag_numberOfConnections :: Lens' Lag (Maybe Int)
lag_jumboFrameCapable :: Lens' Lag (Maybe Bool)
lag_lagState :: Lens' Lag (Maybe LagState)
lag_ownerAccount :: Lens' Lag (Maybe Text)
lag_region :: Lens' Lag (Maybe Text)
lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey])
lag_providerName :: Lens' Lag (Maybe Text)
lag_awsDeviceV2 :: Lens' Lag (Maybe Text)
lag_tags :: Lens' Lag (Maybe (NonEmpty Tag))

Creating a Request

data UpdateLag Source #

See: newUpdateLag smart constructor.

Constructors

UpdateLag'
Fields minimumLinks :: Maybe Int The minimum number of physical connections that must be operational for the LAG itself to be operational. lagName :: Maybe Text The name of the LAG. encryptionMode :: Maybe Text The LAG MAC Security (MACsec) encryption mode. Amazon Web Services applies the value to all connections which are part of the LAG. lagId :: Text The ID of the LAG.

Instances

Instances details

Eq UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods (==) :: UpdateLag -> UpdateLag -> Bool # (/=) :: UpdateLag -> UpdateLag -> Bool #
Read UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods readsPrec :: Int -> ReadS UpdateLag # readList :: ReadS [UpdateLag] # readPrec :: ReadPrec UpdateLag # readListPrec :: ReadPrec [UpdateLag] #
Show UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods showsPrec :: Int -> UpdateLag -> ShowS # show :: UpdateLag -> String # showList :: [UpdateLag] -> ShowS #
Generic UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Associated Types type Rep UpdateLag :: Type -> Type # Methods from :: UpdateLag -> Rep UpdateLag x # to :: Rep UpdateLag x -> UpdateLag #
NFData UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods rnf :: UpdateLag -> () #
Hashable UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods hashWithSalt :: Int -> UpdateLag -> Int # hash :: UpdateLag -> Int #
ToJSON UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods toJSON :: UpdateLag -> Value # toEncoding :: UpdateLag -> Encoding # toJSONList :: [UpdateLag] -> Value # toEncodingList :: [UpdateLag] -> Encoding #
AWSRequest UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Associated Types type AWSResponse UpdateLag # Methods request :: UpdateLag -> Request UpdateLag # response :: MonadResource m => Logger -> Service -> Proxy UpdateLag -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateLag))) #
ToHeaders UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods toHeaders :: UpdateLag -> [Header] #
ToPath UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods toPath :: UpdateLag -> ByteString #
ToQuery UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag Methods toQuery :: UpdateLag -> QueryString #
type Rep UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag type Rep UpdateLag = D1 ('MetaData "UpdateLag" "Amazonka.DirectConnect.UpdateLag" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "UpdateLag'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "minimumLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "lagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lagId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateLag Source #
Instance details Defined in Amazonka.DirectConnect.UpdateLag type AWSResponse UpdateLag = Lag

newUpdateLag Source #

Arguments

:: Text	`$sel:lagId:UpdateLag'`
-> UpdateLag

Create a value of UpdateLag 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:minimumLinks:UpdateLag', updateLag_minimumLinks - The minimum number of physical connections that must be operational for the LAG itself to be operational.

$sel:lagName:UpdateLag', updateLag_lagName - The name of the LAG.

$sel:encryptionMode:UpdateLag', updateLag_encryptionMode - The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

$sel:lagId:UpdateLag', updateLag_lagId - The ID of the LAG.

Request Lenses

updateLag_minimumLinks :: Lens' UpdateLag (Maybe Int) Source #

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

updateLag_lagName :: Lens' UpdateLag (Maybe Text) Source #

The name of the LAG.

updateLag_encryptionMode :: Lens' UpdateLag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

updateLag_lagId :: Lens' UpdateLag Text Source #

The ID of the LAG.

Destructuring the Response

data Lag Source #

Information about a link aggregation group (LAG).

See: newLag smart constructor.

Constructors

Lag'

Fields

lagId :: Maybe Text
The ID of the LAG.
macSecCapable :: Maybe Bool
Indicates whether the LAG supports MAC Security (MACsec).
connectionsBandwidth :: Maybe Text
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
minimumLinks :: Maybe Int
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
lagName :: Maybe Text
The name of the LAG.
location :: Maybe Text
The location of the LAG.
connections :: Maybe [Connection]
The connections bundled by the LAG.
awsDevice :: Maybe Text
The Direct Connect endpoint that hosts the LAG.
hasLogicalRedundancy :: Maybe HasLogicalRedundancy
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
awsLogicalDeviceId :: Maybe Text
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
allowsHostedConnections :: Maybe Bool
Indicates whether the LAG can host other connections.
encryptionMode :: Maybe Text
The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
numberOfConnections :: Maybe Int
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
jumboFrameCapable :: Maybe Bool
Indicates whether jumbo frames (9001 MTU) are supported.
lagState :: Maybe LagState
The state of the LAG. The following are the possible values:
- requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
- pending: The LAG has been approved and is being initialized.
- available: The network link is established and the LAG is ready for use.
- down: The network link is down.
- deleting: The LAG is being deleted.
- deleted: The LAG is deleted.
- unknown: The state of the LAG is not available.
ownerAccount :: Maybe Text
The ID of the Amazon Web Services account that owns the LAG.
region :: Maybe Text
The Amazon Web Services Region where the connection is located.
macSecKeys :: Maybe [MacSecKey]
The MAC Security (MACsec) security keys associated with the LAG.
providerName :: Maybe Text
The name of the service provider associated with the LAG.
awsDeviceV2 :: Maybe Text
The Direct Connect endpoint that hosts the LAG.
tags :: Maybe (NonEmpty Tag)
The tags associated with the LAG.

Instances

Instances details

Eq Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods (==) :: Lag -> Lag -> Bool # (/=) :: Lag -> Lag -> Bool #
Read Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods readsPrec :: Int -> ReadS Lag # readList :: ReadS [Lag] # readPrec :: ReadPrec Lag # readListPrec :: ReadPrec [Lag] #
Show Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods showsPrec :: Int -> Lag -> ShowS # show :: Lag -> String # showList :: [Lag] -> ShowS #
Generic Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Associated Types type Rep Lag :: Type -> Type # Methods from :: Lag -> Rep Lag x # to :: Rep Lag x -> Lag #
NFData Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods rnf :: Lag -> () #
Hashable Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods hashWithSalt :: Int -> Lag -> Int # hash :: Lag -> Int #
FromJSON Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag Methods parseJSON :: Value -> Parser Lag # parseJSONList :: Value -> Parser [Lag] #
type Rep Lag Source #
Instance details Defined in Amazonka.DirectConnect.Types.Lag type Rep Lag = D1 ('MetaData "Lag" "Amazonka.DirectConnect.Types.Lag" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "Lag'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "lagId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "macSecCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "connectionsBandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "lagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Connection]))) :: (S1 ('MetaSel ('Just "awsDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hasLogicalRedundancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HasLogicalRedundancy)) :: S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "allowsHostedConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "numberOfConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "lagState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LagState))))) :: ((S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "macSecKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MacSecKey])))) :: (S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))))))))

newLag :: Lag Source #

Create a value of Lag 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:lagId:Lag', lag_lagId - The ID of the LAG.

$sel:macSecCapable:Lag', lag_macSecCapable - Indicates whether the LAG supports MAC Security (MACsec).

$sel:connectionsBandwidth:Lag', lag_connectionsBandwidth - The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

$sel:minimumLinks:Lag', lag_minimumLinks - The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

$sel:lagName:Lag', lag_lagName - The name of the LAG.

$sel:location:Lag', lag_location - The location of the LAG.

$sel:connections:Lag', lag_connections - The connections bundled by the LAG.

$sel:awsDevice:Lag', lag_awsDevice - The Direct Connect endpoint that hosts the LAG.

$sel:hasLogicalRedundancy:Lag', lag_hasLogicalRedundancy - Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

$sel:awsLogicalDeviceId:Lag', lag_awsLogicalDeviceId - The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

$sel:allowsHostedConnections:Lag', lag_allowsHostedConnections - Indicates whether the LAG can host other connections.

$sel:encryptionMode:Lag', lag_encryptionMode - The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

$sel:numberOfConnections:Lag', lag_numberOfConnections - The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

$sel:jumboFrameCapable:Lag', lag_jumboFrameCapable - Indicates whether jumbo frames (9001 MTU) are supported.

$sel:lagState:Lag', lag_lagState - The state of the LAG. The following are the possible values:

requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.

$sel:ownerAccount:Lag', lag_ownerAccount - The ID of the Amazon Web Services account that owns the LAG.

$sel:region:Lag', lag_region - The Amazon Web Services Region where the connection is located.

$sel:macSecKeys:Lag', lag_macSecKeys - The MAC Security (MACsec) security keys associated with the LAG.

$sel:providerName:Lag', lag_providerName - The name of the service provider associated with the LAG.

$sel:awsDeviceV2:Lag', lag_awsDeviceV2 - The Direct Connect endpoint that hosts the LAG.

$sel:tags:Lag', lag_tags - The tags associated with the LAG.

Response Lenses

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

The ID of the LAG.

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

Indicates whether the LAG supports MAC Security (MACsec).

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

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

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

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

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

The name of the LAG.

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

The location of the LAG.

lag_connections :: Lens' Lag (Maybe [Connection]) Source #

The connections bundled by the LAG.

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

The Direct Connect endpoint that hosts the LAG.

lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

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

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

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

Indicates whether the LAG can host other connections.

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

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

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

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

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

Indicates whether jumbo frames (9001 MTU) are supported.

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

The state of the LAG. The following are the possible values:

requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
pending: The LAG has been approved and is being initialized.
available: The network link is established and the LAG is ready for use.
down: The network link is down.
deleting: The LAG is being deleted.
deleted: The LAG is deleted.
unknown: The state of the LAG is not available.

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

The ID of the Amazon Web Services account that owns the LAG.

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

The Amazon Web Services Region where the connection is located.

lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the LAG.

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

The name of the service provider associated with the LAG.

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

The Direct Connect endpoint that hosts the LAG.

lag_tags :: Lens' Lag (Maybe (NonEmpty Tag)) Source #

The tags associated with the LAG.