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::SageMaker::Device
<a name="aws-resource-sagemaker-device"></a>

The `AWS::SageMaker::Device` resource is an Amazon SageMaker resource type that allows you to register your Devices against an existing SageMaker Edge Manager DeviceFleet. Each device must be listed individually in the CFN specification.

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

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

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

```
{
  "Type" : "AWS::SageMaker::Device",
  "Properties" : {
      "[Device](#cfn-sagemaker-device-device)" : Device,
      "[DeviceFleetName](#cfn-sagemaker-device-devicefleetname)" : String,
      "[Tags](#cfn-sagemaker-device-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::SageMaker::Device
Properties:
  [Device](#cfn-sagemaker-device-device): 
    Device
  [DeviceFleetName](#cfn-sagemaker-device-devicefleetname): String
  [Tags](#cfn-sagemaker-device-tags): 
    - Tag
```

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

`Device`  <a name="cfn-sagemaker-device-device"></a>
Edge device you want to create.  
*Required*: No  
*Type*: [Device](aws-properties-sagemaker-device-device.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeviceFleetName`  <a name="cfn-sagemaker-device-devicefleetname"></a>
The name of the fleet the device belongs to.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$`  
*Minimum*: `1`  
*Maximum*: `63`  
*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-sagemaker-device-tags"></a>
An array of key-value pairs that contain metadata to help you categorize and organize your devices. Each tag consists of a key and a value, both of which you define.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-sagemaker-device-tag.md)  
*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)

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

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DeviceFleetName.

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).

# AWS::SageMaker::Device Device
<a name="aws-properties-sagemaker-device-device"></a>

Information of a particular device.

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

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

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

```
{
  "[Description](#cfn-sagemaker-device-device-description)" : String,
  "[DeviceName](#cfn-sagemaker-device-device-devicename)" : String,
  "[IotThingName](#cfn-sagemaker-device-device-iotthingname)" : String
}
```

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

```
  [Description](#cfn-sagemaker-device-device-description): String
  [DeviceName](#cfn-sagemaker-device-device-devicename): String
  [IotThingName](#cfn-sagemaker-device-device-iotthingname): String
```

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

`Description`  <a name="cfn-sagemaker-device-device-description"></a>
Description of the device.  
*Required*: No  
*Type*: String  
*Pattern*: `[\S\s]+`  
*Minimum*: `1`  
*Maximum*: `40`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeviceName`  <a name="cfn-sagemaker-device-device-devicename"></a>
The name of the device.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IotThingName`  <a name="cfn-sagemaker-device-device-iotthingname"></a>
AWS Internet of Things (IoT) object name.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9:_-]+`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your AWS resources with tagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing AWS resources with tagging, see [Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).

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

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

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

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

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

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

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

`Key`  <a name="cfn-sagemaker-device-tag-key"></a>
The tag key. Tag keys must be unique per resource.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^((?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*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-sagemaker-device-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*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)