Skip to content

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

Description

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with a Direct Connect 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.

Usage

directconnect_associate_mac_sec_key(connectionId, secretARN, ckn, cak)

Arguments

  • connectionId

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

    You can use describe_connections, describe_interconnects, or describe_lags to retrieve connection ID.

  • secretARN

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

    You can use describe_connections or describe_lags to retrieve the MAC Security (MACsec) secret key.

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

  • ckn

    The MAC Security (MACsec) CKN to associate with the 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

    The MAC Security (MACsec) CAK to associate with the 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.

Value

A list with the following syntax:

list(
  connectionId = "string",
  macSecKeys = list(
    list(
      secretARN = "string",
      ckn = "string",
      state = "string",
      startOn = "string"
    )
  )
)

Request syntax

svc$associate_mac_sec_key(
  connectionId = "string",
  secretARN = "string",
  ckn = "string",
  cak = "string"
)