| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DirectConnect.UpdateLag
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' {}
- newUpdateLag :: Text -> UpdateLag
- updateLag_encryptionMode :: Lens' UpdateLag (Maybe Text)
- updateLag_lagName :: Lens' UpdateLag (Maybe Text)
- updateLag_minimumLinks :: Lens' UpdateLag (Maybe Int)
- updateLag_lagId :: Lens' UpdateLag Text
- data Lag = Lag' {
- allowsHostedConnections :: Maybe Bool
- awsDevice :: Maybe Text
- awsDeviceV2 :: Maybe Text
- awsLogicalDeviceId :: Maybe Text
- connections :: Maybe [Connection]
- connectionsBandwidth :: Maybe Text
- encryptionMode :: Maybe Text
- hasLogicalRedundancy :: Maybe HasLogicalRedundancy
- jumboFrameCapable :: Maybe Bool
- lagId :: Maybe Text
- lagName :: Maybe Text
- lagState :: Maybe LagState
- location :: Maybe Text
- macSecCapable :: Maybe Bool
- macSecKeys :: Maybe [MacSecKey]
- minimumLinks :: Maybe Int
- numberOfConnections :: Maybe Int
- ownerAccount :: Maybe Text
- providerName :: Maybe Text
- region :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- newLag :: Lag
- lag_allowsHostedConnections :: Lens' Lag (Maybe Bool)
- lag_awsDevice :: Lens' Lag (Maybe Text)
- lag_awsDeviceV2 :: Lens' Lag (Maybe Text)
- lag_awsLogicalDeviceId :: Lens' Lag (Maybe Text)
- lag_connections :: Lens' Lag (Maybe [Connection])
- lag_connectionsBandwidth :: Lens' Lag (Maybe Text)
- lag_encryptionMode :: Lens' Lag (Maybe Text)
- lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy)
- lag_jumboFrameCapable :: Lens' Lag (Maybe Bool)
- lag_lagId :: Lens' Lag (Maybe Text)
- lag_lagName :: Lens' Lag (Maybe Text)
- lag_lagState :: Lens' Lag (Maybe LagState)
- lag_location :: Lens' Lag (Maybe Text)
- lag_macSecCapable :: Lens' Lag (Maybe Bool)
- lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey])
- lag_minimumLinks :: Lens' Lag (Maybe Int)
- lag_numberOfConnections :: Lens' Lag (Maybe Int)
- lag_ownerAccount :: Lens' Lag (Maybe Text)
- lag_providerName :: Lens' Lag (Maybe Text)
- lag_region :: Lens' Lag (Maybe Text)
- lag_tags :: Lens' Lag (Maybe (NonEmpty Tag))
Creating a Request
See: newUpdateLag smart constructor.
Constructors
| UpdateLag' | |
Fields
| |
Instances
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:
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.
UpdateLag, updateLag_lagName - The name of the LAG.
UpdateLag, updateLag_minimumLinks - The minimum number of physical connections that must be operational for
the LAG itself to be operational.
UpdateLag, updateLag_lagId - The ID of the LAG.
Request Lenses
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_minimumLinks :: Lens' UpdateLag (Maybe Int) Source #
The minimum number of physical connections that must be operational for the LAG itself to be operational.
Destructuring the Response
Information about a link aggregation group (LAG).
See: newLag smart constructor.
Constructors
| Lag' | |
Fields
| |
Instances
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:allowsHostedConnections:Lag', lag_allowsHostedConnections - Indicates whether the LAG can host other connections.
Lag, lag_awsDevice - The Direct Connect endpoint that hosts the LAG.
Lag, lag_awsDeviceV2 - The Direct Connect endpoint that hosts the LAG.
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:connections:Lag', lag_connections - The connections bundled by the LAG.
$sel:connectionsBandwidth:Lag', lag_connectionsBandwidth - The individual bandwidth of the physical connections bundled by the LAG.
The possible values are 1Gbps and 10Gbps.
Lag, lag_encryptionMode - The LAG MAC Security (MACsec) encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
Lag, lag_hasLogicalRedundancy - Indicates whether the LAG supports a secondary BGP peer in the same
address family (IPv4/IPv6).
Lag, lag_jumboFrameCapable - Indicates whether jumbo frames (9001 MTU) are supported.
Lag, lag_lagId - The ID of the LAG.
$sel:lagName:Lag', lag_lagName - The name of the LAG.
$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.
Lag, lag_location - The location of the LAG.
Lag, lag_macSecCapable - Indicates whether the LAG supports MAC Security (MACsec).
Lag, lag_macSecKeys - The MAC Security (MACsec) security keys associated with the LAG.
$sel:minimumLinks:Lag', lag_minimumLinks - The minimum number of physical dedicated connections that must be
operational for the LAG itself to be operational.
$sel:numberOfConnections:Lag', lag_numberOfConnections - The number of physical dedicated connections bundled by the LAG, up to a
maximum of 10.
Lag, lag_ownerAccount - The ID of the Amazon Web Services account that owns the LAG.
Lag, lag_providerName - The name of the service provider associated with the LAG.
Lag, lag_region - The Amazon Web Services Region where the connection is located.
Response Lenses
lag_allowsHostedConnections :: Lens' Lag (Maybe Bool) Source #
Indicates whether the LAG can host other connections.
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_connections :: Lens' Lag (Maybe [Connection]) Source #
The connections bundled by the LAG.
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_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_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
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_macSecCapable :: Lens' Lag (Maybe Bool) Source #
Indicates whether the LAG supports MAC Security (MACsec).
lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #
The MAC Security (MACsec) security keys associated with the LAG.
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_numberOfConnections :: Lens' Lag (Maybe Int) Source #
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
lag_ownerAccount :: Lens' Lag (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the LAG.
lag_providerName :: Lens' Lag (Maybe Text) Source #
The name of the service provider associated with the LAG.