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

Amazonka.DirectConnect.CreateLag

Description

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

All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.

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

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

If the Amazon Web Services account used to create a LAG is a registered 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

data CreateLag Source #

See: newCreateLag smart constructor.

Constructors

CreateLag' 

Fields

Instances

Instances details
Eq CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Read CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Show CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Generic CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Associated Types

type Rep CreateLag :: Type -> Type #

NFData CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Methods

rnf :: CreateLag -> () #

Hashable CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

ToJSON CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

AWSRequest CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Associated Types

type AWSResponse CreateLag #

ToHeaders CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

Methods

toHeaders :: CreateLag -> [Header] #

ToPath CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

ToQuery CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

type Rep CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

type Rep CreateLag = D1 ('MetaData "CreateLag" "Amazonka.DirectConnect.CreateLag" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "CreateLag'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "childConnectionTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestMACSec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "numberOfConnections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "connectionsBandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateLag Source # 
Instance details

Defined in Amazonka.DirectConnect.CreateLag

newCreateLag Source #

Create a value of CreateLag 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:childConnectionTags:CreateLag', createLag_childConnectionTags - The tags to associate with the automtically created LAGs.

$sel:connectionId:CreateLag', createLag_connectionId - The ID of an existing dedicated connection to migrate to the LAG.

$sel:requestMACSec:CreateLag', createLag_requestMACSec - Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

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

$sel:tags:CreateLag', createLag_tags - The tags to associate with the LAG.

$sel:numberOfConnections:CreateLag', createLag_numberOfConnections - The number of physical dedicated connections initially provisioned and bundled by the LAG.

$sel:location:CreateLag', createLag_location - The location for the LAG.

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

$sel:lagName:CreateLag', createLag_lagName - The name of the LAG.

Request Lenses

createLag_childConnectionTags :: Lens' CreateLag (Maybe (NonEmpty Tag)) Source #

The tags to associate with the automtically created LAGs.

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

The ID of an existing dedicated connection to migrate to the LAG.

createLag_requestMACSec :: Lens' CreateLag (Maybe Bool) Source #

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

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

The name of the service provider associated with the LAG.

createLag_tags :: Lens' CreateLag (Maybe (NonEmpty Tag)) Source #

The tags to associate with the LAG.

createLag_numberOfConnections :: Lens' CreateLag Int Source #

The number of physical dedicated connections initially provisioned and bundled by the LAG.

createLag_location :: Lens' CreateLag Text Source #

The location for the LAG.

createLag_connectionsBandwidth :: Lens' CreateLag Text Source #

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

createLag_lagName :: Lens' CreateLag Text Source #

The name of the LAG.

Destructuring the Response

data Lag Source #

Information about a link aggregation group (LAG).

See: newLag smart constructor.

Constructors

Lag' 

Fields

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

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

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.