AWS::NetworkManager::Device

Specifies a device.

Syntax

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

JSON

{
  "Type" : "AWS::NetworkManager::Device",
  "Properties" : {
      "AWSLocation" : AWSLocation,
      "Description" : String,
      "GlobalNetworkId" : String,
      "Location" : Location,
      "Model" : String,
      "SerialNumber" : String,
      "SiteId" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String,
      "Vendor" : String
    }
}

YAML

Type: AWS::NetworkManager::Device
Properties:
  AWSLocation: 
    AWSLocation
  Description: String
  GlobalNetworkId: String
  Location: 
    Location
  Model: String
  SerialNumber: String
  SiteId: String
  Tags: 
    - Tag
  Type: String
  Vendor: String

Properties

AWSLocation

The AWS location of the device.

Required: No

Type: AWSLocation

Update requires: No interruption

Description

A description of the device.

Constraints: Maximum length of 256 characters.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

GlobalNetworkId

The ID of the global network.

Required: Yes

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 50

Update requires: Replacement

Location

The site location.

Required: No

Type: Location

Update requires: No interruption

Model

The model of the device.

Constraints: Maximum length of 128 characters.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

SerialNumber

The serial number of the device.

Constraints: Maximum length of 128 characters.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

SiteId

The site ID.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 50

Update requires: No interruption

Tags

The tags for the device.

Required: No

Type: Array of Tag

Update requires: No interruption

Type

The device type.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

Vendor

The vendor of the device.

Constraints: Maximum length of 128 characters.

Required: No

Type: String

Pattern: [\s\S]*

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the IDs of the global network and device. For example: global-network-01231231231231231|device-07f6fd08867abc123.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The time that the device was created.

DeviceArn

The ARN of the device. For example, arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123.

DeviceId

The ID of the device. For example, device-07f6fd08867abc123.

State

The state of the device.

Examples

Device

The following example creates a device in a global network.

JSON

{
    "Type": "AWS::NetworkManager::Device",
    "Properties": {
        "Description": "Chicago office device",
        "GlobalNetworkId": {
            "Ref": "GlobalNetwork"
        },
        "SiteId": {
            "Fn::GetAtt": [
                "Site",
                "SiteId"
            ]
        },
        "Location": {
            "Address": "227 W Monroe St, Chicago, IL 60606",
            "Latitude": "41.8",
            "Longitude": "-87.6"
        },
        "Tags": [
            {
                "Key": "Network",
                "Value": "north-america"
            }
        ]
    }
}

YAML

Type: AWS::NetworkManager::Device
Properties:
  Description: "Chicago office device"
  GlobalNetworkId: !Ref GlobalNetwork
  SiteId: !GetAtt Site.SiteId
  Location:
    Address: "227 W Monroe St, Chicago, IL 60606"
    Latitude: "41.8"
    Longitude: "-87.6"
  Tags:
    - Key: Network
      Value: north-america