AWS::SageMaker::DeviceFleet - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::SageMaker::DeviceFleet

The AWS::SageMaker::DeviceFleet resource is an Amazon SageMaker resource type that allows you to create a DeviceFleet that manages your SageMaker Edge Manager Devices. You must register your devices against the DeviceFleet separately.

Syntax

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

JSON

{
  "Type" : "AWS::SageMaker::DeviceFleet",
  "Properties" : {
      "Description" : String,
      "DeviceFleetName" : String,
      "OutputConfig" : EdgeOutputConfig,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SageMaker::DeviceFleet
Properties: 
  Description: String
  DeviceFleetName: String
  OutputConfig: 
    EdgeOutputConfig
  RoleArn: String
  Tags: 
    - Tag

Properties

Description

A description of the fleet.

Required: No

Type: String

Update requires: No interruption

DeviceFleetName

Name of the device fleet.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Update requires: Replacement

OutputConfig

The output configuration for storing sample data collected by the fleet.

Required: Yes

Type: EdgeOutputConfig

Update requires: No interruption

RoleArn

The Amazon Resource Name (ARN) that has access to Amazon Internet of Things (IoT).

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Update requires: No interruption

Tags

An array of key-value pairs that contain metadata to help you categorize and organize your device fleets. Each tag consists of a key and a value, both of which you define.

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the DeviceFleetName.

For more information about using the Reffunction, see Ref.