Skip to content

Update Connection

directconnect_update_connection R Documentation

Updates the Direct Connect dedicated connection configuration

Description

Updates the Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

  • The connection name

  • The connection's MAC Security (MACsec) encryption mode.

Usage

directconnect_update_connection(connectionId, connectionName,
  encryptionMode)

Arguments

connectionId

[required] The ID of the dedicated connection.

You can use describe_connections to retrieve the connection ID.

connectionName

The name of the connection.

encryptionMode

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

Value

A list with the following syntax:

list(
  ownerAccount = "string",
  connectionId = "string",
  connectionName = "string",
  connectionState = "ordering"|"requested"|"pending"|"available"|"down"|"deleting"|"deleted"|"rejected"|"unknown",
  region = "string",
  location = "string",
  bandwidth = "string",
  vlan = 123,
  partnerName = "string",
  loaIssueTime = as.POSIXct(
    "2015-01-01"
  ),
  lagId = "string",
  awsDevice = "string",
  jumboFrameCapable = TRUE|FALSE,
  awsDeviceV2 = "string",
  awsLogicalDeviceId = "string",
  hasLogicalRedundancy = "unknown"|"yes"|"no",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  providerName = "string",
  macSecCapable = TRUE|FALSE,
  portEncryptionStatus = "string",
  encryptionMode = "string",
  macSecKeys = list(
    list(
      secretARN = "string",
      ckn = "string",
      state = "string",
      startOn = "string"
    )
  )
)

Request syntax

svc$update_connection(
  connectionId = "string",
  connectionName = "string",
  encryptionMode = "string"
)