AWS::SageMaker::DeviceFleet - AWS CloudFormation (original) (raw)

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 AWS CloudFormation template, use the following syntax:

JSON

{
  "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

Pattern: [\S\s]+

Minimum: 0

Maximum: 800

Update requires: No interruption

DeviceFleetName

Name of the device fleet.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$

Minimum: 1

Maximum: 63

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 AWS Internet of Things (IoT).

Required: Yes

Type: String

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

Minimum: 20

Maximum: 2048

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: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

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