Skip to content

Allocate Hosted Connection

directconnect_allocate_hosted_connection R Documentation

Description

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

Usage

directconnect_allocate_hosted_connection(connectionId, ownerAccount,
  bandwidth, connectionName, vlan, tags)

Arguments

connectionId

[required] The ID of the interconnect or LAG.

ownerAccount

[required] The ID of the Amazon Web Services account ID of the customer for the connection.

bandwidth

[required] The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.

connectionName

[required] The name of the hosted connection.

vlan

[required] The dedicated VLAN provisioned to the hosted connection.

tags

The tags associated with the connection.

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$allocate_hosted_connection(
  connectionId = "string",
  ownerAccount = "string",
  bandwidth = "string",
  connectionName = "string",
  vlan = 123,
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)