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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

Synopsis

data AssociateMacSecKey = AssociateMacSecKey' {
- ckn :: Maybe Text
- cak :: Maybe Text
- secretARN :: Maybe Text
- connectionId :: Text
}
newAssociateMacSecKey :: Text -> AssociateMacSecKey
associateMacSecKey_ckn :: Lens' AssociateMacSecKey (Maybe Text)
associateMacSecKey_cak :: Lens' AssociateMacSecKey (Maybe Text)
associateMacSecKey_secretARN :: Lens' AssociateMacSecKey (Maybe Text)
associateMacSecKey_connectionId :: Lens' AssociateMacSecKey Text
data AssociateMacSecKeyResponse = AssociateMacSecKeyResponse' {
- connectionId :: Maybe Text
- macSecKeys :: Maybe [MacSecKey]
- httpStatus :: Int
}
newAssociateMacSecKeyResponse :: Int -> AssociateMacSecKeyResponse
associateMacSecKeyResponse_connectionId :: Lens' AssociateMacSecKeyResponse (Maybe Text)
associateMacSecKeyResponse_macSecKeys :: Lens' AssociateMacSecKeyResponse (Maybe [MacSecKey])
associateMacSecKeyResponse_httpStatus :: Lens' AssociateMacSecKeyResponse Int

Creating a Request

data AssociateMacSecKey Source #

See: newAssociateMacSecKey smart constructor.

Constructors

AssociateMacSecKey'

Fields

ckn :: Maybe Text
The MAC Security (MACsec) CKN to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.
cak :: Maybe Text
The MAC Security (MACsec) CAK to associate with the dedicated connection.
You can create the CKN/CAK pair using an industry standard tool.
The valid values are 64 hexadecimal characters (0-9, A-E).
If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.
secretARN :: Maybe Text
The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.
You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.
If you use this request parameter, you do not use the ckn and cak request parameters.
connectionId :: Text
The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).
You can use DescribeConnections or DescribeLags to retrieve connection ID.

Instances

Instances details

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

newAssociateMacSecKey Source #

Arguments

:: Text	`$sel:connectionId:AssociateMacSecKey'`
-> AssociateMacSecKey

Create a value of AssociateMacSecKey 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:ckn:AssociateMacSecKey', associateMacSecKey_ckn - The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

$sel:cak:AssociateMacSecKey', associateMacSecKey_cak - The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

$sel:secretARN:AssociateMacSecKey', associateMacSecKey_secretARN - The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

$sel:connectionId:AssociateMacSecKey', associateMacSecKey_connectionId - The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

Request Lenses

associateMacSecKey_ckn :: Lens' AssociateMacSecKey (Maybe Text) Source #

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

associateMacSecKey_cak :: Lens' AssociateMacSecKey (Maybe Text) Source #

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

associateMacSecKey_secretARN :: Lens' AssociateMacSecKey (Maybe Text) Source #

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

associateMacSecKey_connectionId :: Lens' AssociateMacSecKey Text Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

Destructuring the Response

data AssociateMacSecKeyResponse Source #

See: newAssociateMacSecKeyResponse smart constructor.

Constructors

AssociateMacSecKeyResponse'
Fields connectionId :: Maybe Text The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx). macSecKeys :: Maybe [MacSecKey] The MAC Security (MACsec) security keys associated with the dedicated connection. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey Methods (==) :: AssociateMacSecKeyResponse -> AssociateMacSecKeyResponse -> Bool # (/=) :: AssociateMacSecKeyResponse -> AssociateMacSecKeyResponse -> Bool #
Read AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey Methods readsPrec :: Int -> ReadS AssociateMacSecKeyResponse # readList :: ReadS [AssociateMacSecKeyResponse] # readPrec :: ReadPrec AssociateMacSecKeyResponse # readListPrec :: ReadPrec [AssociateMacSecKeyResponse] #
Show AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey Methods showsPrec :: Int -> AssociateMacSecKeyResponse -> ShowS # show :: AssociateMacSecKeyResponse -> String # showList :: [AssociateMacSecKeyResponse] -> ShowS #
Generic AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey Associated Types type Rep AssociateMacSecKeyResponse :: Type -> Type # Methods from :: AssociateMacSecKeyResponse -> Rep AssociateMacSecKeyResponse x # to :: Rep AssociateMacSecKeyResponse x -> AssociateMacSecKeyResponse #
NFData AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey Methods rnf :: AssociateMacSecKeyResponse -> () #
type Rep AssociateMacSecKeyResponse Source #
Instance details Defined in Amazonka.DirectConnect.AssociateMacSecKey type Rep AssociateMacSecKeyResponse = D1 ('MetaData "AssociateMacSecKeyResponse" "Amazonka.DirectConnect.AssociateMacSecKey" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "AssociateMacSecKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "macSecKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MacSecKey])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateMacSecKeyResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateMacSecKeyResponse'`
-> AssociateMacSecKeyResponse

Create a value of AssociateMacSecKeyResponse 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:AssociateMacSecKey', associateMacSecKeyResponse_connectionId - The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

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

$sel:httpStatus:AssociateMacSecKeyResponse', associateMacSecKeyResponse_httpStatus - The response's http status code.

Response Lenses

associateMacSecKeyResponse_connectionId :: Lens' AssociateMacSecKeyResponse (Maybe Text) Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

associateMacSecKeyResponse_macSecKeys :: Lens' AssociateMacSecKeyResponse (Maybe [MacSecKey]) Source #

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

associateMacSecKeyResponse_httpStatus :: Lens' AssociateMacSecKeyResponse Int Source #

The response's http status code.