Skip to content

Creates an association between a Direct Connect gateway and a virtual private gateway

Description

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

Usage

directconnect_create_direct_connect_gateway_association(
  directConnectGatewayId, gatewayId,
  addAllowedPrefixesToDirectConnectGateway, virtualGatewayId)

Arguments

  • directConnectGatewayId

    [required] The ID of the Direct Connect gateway.

  • gatewayId

    The ID of the virtual private gateway or transit gateway.

  • addAllowedPrefixesToDirectConnectGateway

    The Amazon VPC prefixes to advertise to the Direct Connect gateway

    This parameter is required when you create an association to a transit gateway.

    For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

  • virtualGatewayId

    The ID of the virtual private gateway.

Value

A list with the following syntax:

list(
  directConnectGatewayAssociation = list(
    directConnectGatewayId = "string",
    directConnectGatewayOwnerAccount = "string",
    associationState = "associating"|"associated"|"disassociating"|"disassociated"|"updating",
    stateChangeError = "string",
    associatedGateway = list(
      id = "string",
      type = "virtualPrivateGateway"|"transitGateway",
      ownerAccount = "string",
      region = "string"
    ),
    associationId = "string",
    allowedPrefixesToDirectConnectGateway = list(
      list(
        cidr = "string"
      )
    ),
    associatedCoreNetwork = list(
      id = "string",
      ownerAccount = "string",
      attachmentId = "string"
    ),
    virtualGatewayId = "string",
    virtualGatewayRegion = "string",
    virtualGatewayOwnerAccount = "string"
  )
)

Request syntax

svc$create_direct_connect_gateway_association(
  directConnectGatewayId = "string",
  gatewayId = "string",
  addAllowedPrefixesToDirectConnectGateway = list(
    list(
      cidr = "string"
    )
  ),
  virtualGatewayId = "string"
)