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.AssociateHostedConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to Amazon Web Services as it is being migrated.

Intended for use by Direct Connect Partners only.

Synopsis

data AssociateHostedConnection = AssociateHostedConnection' {
- connectionId :: Text
- parentConnectionId :: Text
}
newAssociateHostedConnection :: Text -> Text -> AssociateHostedConnection
associateHostedConnection_connectionId :: Lens' AssociateHostedConnection Text
associateHostedConnection_parentConnectionId :: Lens' AssociateHostedConnection Text
data Connection = Connection' {
- lagId :: Maybe Text
- macSecCapable :: Maybe Bool
- portEncryptionStatus :: Maybe Text
- vlan :: Maybe Int
- location :: Maybe Text
- awsDevice :: Maybe Text
- hasLogicalRedundancy :: Maybe HasLogicalRedundancy
- connectionId :: Maybe Text
- awsLogicalDeviceId :: Maybe Text
- loaIssueTime :: Maybe POSIX
- partnerName :: Maybe Text
- connectionName :: Maybe Text
- encryptionMode :: Maybe Text
- bandwidth :: Maybe Text
- jumboFrameCapable :: Maybe Bool
- ownerAccount :: Maybe Text
- region :: Maybe Text
- macSecKeys :: Maybe [MacSecKey]
- providerName :: Maybe Text
- awsDeviceV2 :: Maybe Text
- connectionState :: Maybe ConnectionState
- tags :: Maybe (NonEmpty Tag)
}
newConnection :: Connection
connection_lagId :: Lens' Connection (Maybe Text)
connection_macSecCapable :: Lens' Connection (Maybe Bool)
connection_portEncryptionStatus :: Lens' Connection (Maybe Text)
connection_vlan :: Lens' Connection (Maybe Int)
connection_location :: Lens' Connection (Maybe Text)
connection_awsDevice :: Lens' Connection (Maybe Text)
connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy)
connection_connectionId :: Lens' Connection (Maybe Text)
connection_awsLogicalDeviceId :: Lens' Connection (Maybe Text)
connection_loaIssueTime :: Lens' Connection (Maybe UTCTime)
connection_partnerName :: Lens' Connection (Maybe Text)
connection_connectionName :: Lens' Connection (Maybe Text)
connection_encryptionMode :: Lens' Connection (Maybe Text)
connection_bandwidth :: Lens' Connection (Maybe Text)
connection_jumboFrameCapable :: Lens' Connection (Maybe Bool)
connection_ownerAccount :: Lens' Connection (Maybe Text)
connection_region :: Lens' Connection (Maybe Text)
connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey])
connection_providerName :: Lens' Connection (Maybe Text)
connection_awsDeviceV2 :: Lens' Connection (Maybe Text)
connection_connectionState :: Lens' Connection (Maybe ConnectionState)
connection_tags :: Lens' Connection (Maybe (NonEmpty Tag))

Creating a Request

data AssociateHostedConnection Source #

See: newAssociateHostedConnection smart constructor.

Constructors

AssociateHostedConnection'
Fields connectionId :: Text The ID of the hosted connection. parentConnectionId :: Text The ID of the interconnect or the LAG.

Instances

Instances details

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

newAssociateHostedConnection Source #

Arguments

:: Text	`$sel:connectionId:AssociateHostedConnection'`
-> Text	`$sel:parentConnectionId:AssociateHostedConnection'`
-> AssociateHostedConnection

Create a value of AssociateHostedConnection 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:connectionId:AssociateHostedConnection', associateHostedConnection_connectionId - The ID of the hosted connection.

$sel:parentConnectionId:AssociateHostedConnection', associateHostedConnection_parentConnectionId - The ID of the interconnect or the LAG.

Request Lenses

associateHostedConnection_connectionId :: Lens' AssociateHostedConnection Text Source #

The ID of the hosted connection.

associateHostedConnection_parentConnectionId :: Lens' AssociateHostedConnection Text Source #

The ID of the interconnect or the LAG.

Destructuring the Response

data Connection Source #

Information about an Direct Connect connection.

See: newConnection smart constructor.

Constructors

Connection'

Fields

lagId :: Maybe Text
The ID of the LAG.
macSecCapable :: Maybe Bool
Indicates whether the connection supports MAC Security (MACsec).
portEncryptionStatus :: Maybe Text
The MAC Security (MACsec) port link status of the connection.
The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.
vlan :: Maybe Int
The ID of the VLAN.
location :: Maybe Text
The location of the connection.
awsDevice :: Maybe Text
The Direct Connect endpoint on which the physical connection terminates.
hasLogicalRedundancy :: Maybe HasLogicalRedundancy
Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
connectionId :: Maybe Text
The ID of the connection.
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.
loaIssueTime :: Maybe POSIX
The time of the most recent call to DescribeLoa for this connection.
partnerName :: Maybe Text
The name of the Direct Connect service provider associated with the connection.
connectionName :: Maybe Text
The name of the connection.
encryptionMode :: Maybe Text
The MAC Security (MACsec) connection encryption mode.
The valid values are no_encrypt, should_encrypt, and must_encrypt.
bandwidth :: Maybe Text
The bandwidth of the connection.
jumboFrameCapable :: Maybe Bool
Indicates whether jumbo frames (9001 MTU) are supported.
ownerAccount :: Maybe Text
The ID of the Amazon Web Services account that owns the connection.
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 connection.
providerName :: Maybe Text
The name of the service provider associated with the connection.
awsDeviceV2 :: Maybe Text
The Direct Connect endpoint that terminates the physical connection.
connectionState :: Maybe ConnectionState
The state of the connection. The following are the possible values:
- ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
- requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
- pending: The connection has been approved and is being initialized.
- available: The network link is up and the connection is ready for use.
- down: The network link is down.
- deleting: The connection is being deleted.
- deleted: The connection has been deleted.
- rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
- unknown: The state of the connection is not available.
tags :: Maybe (NonEmpty Tag)
The tags associated with the connection.

Instances

Instances details

Eq Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods (==) :: Connection -> Connection -> Bool # (/=) :: Connection -> Connection -> Bool #
Read Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods readsPrec :: Int -> ReadS Connection # readList :: ReadS [Connection] # readPrec :: ReadPrec Connection # readListPrec :: ReadPrec [Connection] #
Show Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods showsPrec :: Int -> Connection -> ShowS # show :: Connection -> String # showList :: [Connection] -> ShowS #
Generic Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Associated Types type Rep Connection :: Type -> Type # Methods from :: Connection -> Rep Connection x # to :: Rep Connection x -> Connection #
NFData Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods rnf :: Connection -> () #
Hashable Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods hashWithSalt :: Int -> Connection -> Int # hash :: Connection -> Int #
FromJSON Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection Methods parseJSON :: Value -> Parser Connection # parseJSONList :: Value -> Parser [Connection] #
type Rep Connection Source #
Instance details Defined in Amazonka.DirectConnect.Types.Connection type Rep Connection = D1 ('MetaData "Connection" "Amazonka.DirectConnect.Types.Connection" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "Connection'" '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 "portEncryptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "awsDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hasLogicalRedundancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HasLogicalRedundancy)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "loaIssueTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "partnerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "connectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "bandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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 "connectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))))))))

newConnection :: Connection Source #

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

$sel:macSecCapable:Connection', connection_macSecCapable - Indicates whether the connection supports MAC Security (MACsec).

$sel:portEncryptionStatus:Connection', connection_portEncryptionStatus - The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

$sel:vlan:Connection', connection_vlan - The ID of the VLAN.

$sel:location:Connection', connection_location - The location of the connection.

$sel:awsDevice:Connection', connection_awsDevice - The Direct Connect endpoint on which the physical connection terminates.

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

$sel:connectionId:Connection', connection_connectionId - The ID of the connection.

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

$sel:loaIssueTime:Connection', connection_loaIssueTime - The time of the most recent call to DescribeLoa for this connection.

$sel:partnerName:Connection', connection_partnerName - The name of the Direct Connect service provider associated with the connection.

$sel:connectionName:Connection', connection_connectionName - The name of the connection.

$sel:encryptionMode:Connection', connection_encryptionMode - The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

$sel:bandwidth:Connection', connection_bandwidth - The bandwidth of the connection.

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

$sel:ownerAccount:Connection', connection_ownerAccount - The ID of the Amazon Web Services account that owns the connection.

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

$sel:macSecKeys:Connection', connection_macSecKeys - The MAC Security (MACsec) security keys associated with the connection.

$sel:providerName:Connection', connection_providerName - The name of the service provider associated with the connection.

$sel:awsDeviceV2:Connection', connection_awsDeviceV2 - The Direct Connect endpoint that terminates the physical connection.

$sel:connectionState:Connection', connection_connectionState - The state of the connection. The following are the possible values:

ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.

$sel:tags:Connection', connection_tags - The tags associated with the connection.

Response Lenses

connection_lagId :: Lens' Connection (Maybe Text) Source #

The ID of the LAG.

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

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

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

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

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

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

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

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

ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
pending: The connection has been approved and is being initialized.
available: The network link is up and the connection is ready for use.
down: The network link is down.
deleting: The connection is being deleted.
deleted: The connection has been deleted.
rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.