AWS::NetworkManager::LinkAssociation

Describes the association between a device and a link.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::NetworkManager::LinkAssociation",
  "Properties" : {
      "DeviceId" : String,
      "GlobalNetworkId" : String,
      "LinkId" : String
    }
}

YAML

Type: AWS::NetworkManager::LinkAssociation
Properties: 
  DeviceId: String
  GlobalNetworkId: String
  LinkId: String

Properties

DeviceId

The device ID for the link association.

Required: Yes

Type: String

Minimum: 0

Maximum: 50

Pattern: [\s\S]*

Update requires: Replacement

GlobalNetworkId

The ID of the global network.

Required: Yes

Type: String

Minimum: 0

Maximum: 50

Pattern: [\s\S]*

Update requires: Replacement

LinkId

The ID of the link.

Required: Yes

Type: String

Minimum: 0

Maximum: 50

Pattern: [\s\S]*

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the IDs of the global network, device, and link. For example: global-network-01231231231231231|device-07f6fd08867abc123|link-11112222aaaabbbb1.

For more information about using the Reffunction, see Ref.

Examples

Link Association

The following example template creates a global network, site, link, and device. It creates an association between the link and the device.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Create global network and link association",
    "Resources": {
        "GlobalNetwork": {
            "Type": "AWS::NetworkManager::GlobalNetwork"
        },
        "Site": {
            "Type": "AWS::NetworkManager::Site",
            "Properties": {
                "GlobalNetworkId": {
                    "Ref": "GlobalNetwork"
                },
                "Location": {
                    "Address": "227 W Monroe St, Chicago, IL 60606",
                    "Latitude": "41.8",
                    "Longitude": "-87.6"
                }
            }
        },
        "Link": {
            "Type": "AWS::NetworkManager::Link",
            "Properties": {
                "Description": "Broadband link",
                "GlobalNetworkId": {
                    "Ref": "GlobalNetwork"
                },
                "SiteId": {
                    "Fn::GetAtt": [
                        "Site",
                        "SiteId"
                    ]
                },
                "Bandwidth": {
                    "DownloadSpeed": 20,
                    "UploadSpeed": 20
                },
                "Provider": "AnyCompany",
                "Type": "Broadband",
                "Tags": [
                    {
                        "Key": "Name",
                        "Value": "broadband-link-1"
                    }
                ]
            }
        },
        "Device": {
            "Type": "AWS::NetworkManager::Device",
            "Properties": {
                "Description": "Chicago office device",
                "GlobalNetworkId": {
                    "Ref": "GlobalNetwork"
                },
                "SiteId": {
                    "Fn::GetAtt": [
                        "Site",
                        "SiteId"
                    ]
                },
                "Tags": [
                    {
                        "Key": "Network",
                        "Value": "north-america"
                    }
                ]
            }
        },
        "LinkAssociation": {
            "Type": "AWS::NetworkManager::LinkAssociation",
            "Properties": {
                "GlobalNetworkId": {
                    "Ref": "GlobalNetwork"
                },
                "LinkId": {
                    "Fn::GetAtt": [
                        "Link",
                        "LinkId"
                    ]
                },
                "DeviceId": {
                    "Fn::GetAtt": [
                        "Device",
                        "DeviceId"
                    ]
                }
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: 'Create global network and link association'
Resources:
  GlobalNetwork:
    Type: AWS::NetworkManager::GlobalNetwork
  Site:
    Type: AWS::NetworkManager::Site
    Properties:
      GlobalNetworkId: !Ref GlobalNetwork
      Location:
        Address: "227 W Monroe St, Chicago, IL 60606"
        Latitude: "41.8"
        Longitude: "-87.6"
  Link:
    Type: AWS::NetworkManager::Link
    Properties:
      Description: Broadband link
      GlobalNetworkId: !Ref GlobalNetwork
      SiteId: !GetAtt Site.SiteId
      Bandwidth:
        DownloadSpeed: 20
        UploadSpeed: 20
      Provider: "AnyCompany"
      Type: "Broadband"
      Tags:
        - Key: Name
          Value: broadband-link-1
  Device:
    Type: AWS::NetworkManager::Device
    Properties:
      Description: Chicago office device
      GlobalNetworkId: !Ref GlobalNetwork
      SiteId: !GetAtt Site.SiteId
      Tags:
        - Key: Network
          Value: north-america
  LinkAssociation:
    Type: AWS::NetworkManager::LinkAssociation
    Properties:
      GlobalNetworkId: !Ref GlobalNetwork
      LinkId: !GetAtt Link.LinkId
      DeviceId: !GetAtt Device.DeviceId