This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::NetworkManager::Device
<a name="aws-resource-networkmanager-device"></a>

Specifies a device.

## Syntax
<a name="aws-resource-networkmanager-device-syntax"></a>

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

### JSON
<a name="aws-resource-networkmanager-device-syntax.json"></a>

```
{
  "Type" : "AWS::NetworkManager::Device",
  "Properties" : {
      "[AWSLocation](#cfn-networkmanager-device-awslocation)" : AWSLocation,
      "[Description](#cfn-networkmanager-device-description)" : String,
      "[GlobalNetworkId](#cfn-networkmanager-device-globalnetworkid)" : String,
      "[Location](#cfn-networkmanager-device-location)" : Location,
      "[Model](#cfn-networkmanager-device-model)" : String,
      "[SerialNumber](#cfn-networkmanager-device-serialnumber)" : String,
      "[SiteId](#cfn-networkmanager-device-siteid)" : String,
      "[Tags](#cfn-networkmanager-device-tags)" : [ Tag, ... ],
      "[Type](#cfn-networkmanager-device-type)" : String,
      "[Vendor](#cfn-networkmanager-device-vendor)" : String
    }
}
```

### YAML
<a name="aws-resource-networkmanager-device-syntax.yaml"></a>

```
Type: AWS::NetworkManager::Device
Properties:
  [AWSLocation](#cfn-networkmanager-device-awslocation): 
    AWSLocation
  [Description](#cfn-networkmanager-device-description): String
  [GlobalNetworkId](#cfn-networkmanager-device-globalnetworkid): String
  [Location](#cfn-networkmanager-device-location): 
    Location
  [Model](#cfn-networkmanager-device-model): String
  [SerialNumber](#cfn-networkmanager-device-serialnumber): String
  [SiteId](#cfn-networkmanager-device-siteid): String
  [Tags](#cfn-networkmanager-device-tags): 
    - Tag
  [Type](#cfn-networkmanager-device-type): String
  [Vendor](#cfn-networkmanager-device-vendor): String
```

## Properties
<a name="aws-resource-networkmanager-device-properties"></a>

`AWSLocation`  <a name="cfn-networkmanager-device-awslocation"></a>
The AWS location of the device.  
*Required*: No  
*Type*: [AWSLocation](aws-properties-networkmanager-device-awslocation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-networkmanager-device-description"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalNetworkId`  <a name="cfn-networkmanager-device-globalnetworkid"></a>
The ID of the global network.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Location`  <a name="cfn-networkmanager-device-location"></a>
The site location.  
*Required*: No  
*Type*: [Location](aws-properties-networkmanager-device-location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Model`  <a name="cfn-networkmanager-device-model"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SerialNumber`  <a name="cfn-networkmanager-device-serialnumber"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SiteId`  <a name="cfn-networkmanager-device-siteid"></a>
The site ID.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-networkmanager-device-tags"></a>
The tags for the device.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-networkmanager-device-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-networkmanager-device-type"></a>
The device type.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Vendor`  <a name="cfn-networkmanager-device-vendor"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-networkmanager-device-return-values"></a>

### Ref
<a name="aws-resource-networkmanager-device-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-networkmanager-device-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-networkmanager-device-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
The time that the device was created.

`DeviceArn`  <a name="DeviceArn-fn::getatt"></a>
The ARN of the device. For example, `arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123`.

`DeviceId`  <a name="DeviceId-fn::getatt"></a>
The ID of the device. For example, `device-07f6fd08867abc123`.

`State`  <a name="State-fn::getatt"></a>
The state of the device.

## Examples
<a name="aws-resource-networkmanager-device--examples"></a>



### Device
<a name="aws-resource-networkmanager-device--examples--Device"></a>

The following example creates a device in a global network.

#### JSON
<a name="aws-resource-networkmanager-device--examples--Device--json"></a>

```
{
    "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
<a name="aws-resource-networkmanager-device--examples--Device--yaml"></a>

```
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
```

# AWS::NetworkManager::Device AWSLocation
<a name="aws-properties-networkmanager-device-awslocation"></a>

Specifies a location in AWS.

## Syntax
<a name="aws-properties-networkmanager-device-awslocation-syntax"></a>

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

### JSON
<a name="aws-properties-networkmanager-device-awslocation-syntax.json"></a>

```
{
  "[SubnetArn](#cfn-networkmanager-device-awslocation-subnetarn)" : String,
  "[Zone](#cfn-networkmanager-device-awslocation-zone)" : String
}
```

### YAML
<a name="aws-properties-networkmanager-device-awslocation-syntax.yaml"></a>

```
  [SubnetArn](#cfn-networkmanager-device-awslocation-subnetarn): String
  [Zone](#cfn-networkmanager-device-awslocation-zone): String
```

## Properties
<a name="aws-properties-networkmanager-device-awslocation-properties"></a>

`SubnetArn`  <a name="cfn-networkmanager-device-awslocation-subnetarn"></a>
The Amazon Resource Name (ARN) of the subnet that the device is located in.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\/subnet-[0-9a-f]{8,17}$|^$`  
*Minimum*: `0`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Zone`  <a name="cfn-networkmanager-device-awslocation-zone"></a>
The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkManager::Device Location
<a name="aws-properties-networkmanager-device-location"></a>

Describes a location.

## Syntax
<a name="aws-properties-networkmanager-device-location-syntax"></a>

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

### JSON
<a name="aws-properties-networkmanager-device-location-syntax.json"></a>

```
{
  "[Address](#cfn-networkmanager-device-location-address)" : String,
  "[Latitude](#cfn-networkmanager-device-location-latitude)" : String,
  "[Longitude](#cfn-networkmanager-device-location-longitude)" : String
}
```

### YAML
<a name="aws-properties-networkmanager-device-location-syntax.yaml"></a>

```
  [Address](#cfn-networkmanager-device-location-address): String
  [Latitude](#cfn-networkmanager-device-location-latitude): String
  [Longitude](#cfn-networkmanager-device-location-longitude): String
```

## Properties
<a name="aws-properties-networkmanager-device-location-properties"></a>

`Address`  <a name="cfn-networkmanager-device-location-address"></a>
The physical address.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Latitude`  <a name="cfn-networkmanager-device-location-latitude"></a>
The latitude.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Longitude`  <a name="cfn-networkmanager-device-location-longitude"></a>
The longitude.  
*Required*: No  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::NetworkManager::Device Tag
<a name="aws-properties-networkmanager-device-tag"></a>

Describes a tag.

## Syntax
<a name="aws-properties-networkmanager-device-tag-syntax"></a>

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

### JSON
<a name="aws-properties-networkmanager-device-tag-syntax.json"></a>

```
{
  "[Key](#cfn-networkmanager-device-tag-key)" : String,
  "[Value](#cfn-networkmanager-device-tag-value)" : String
}
```

### YAML
<a name="aws-properties-networkmanager-device-tag-syntax.yaml"></a>

```
  [Key](#cfn-networkmanager-device-tag-key): String
  [Value](#cfn-networkmanager-device-tag-value): String
```

## Properties
<a name="aws-properties-networkmanager-device-tag-properties"></a>

`Key`  <a name="cfn-networkmanager-device-tag-key"></a>
The tag key.  
Constraints: Maximum length of 128 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `10000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-networkmanager-device-tag-value"></a>
The tag value.  
Constraints: Maximum length of 256 characters.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\s\S]*`  
*Minimum*: `0`  
*Maximum*: `10000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)