AWS::IoTManagedIntegrations::ManagedThing - 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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoTManagedIntegrations::ManagedThing

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a protocol-specific format.

Syntax

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

JSON

{
  "Type" : "AWS::IoTManagedIntegrations::ManagedThing",
  "Properties" : {
      "AuthenticationMaterial" : String,
      "AuthenticationMaterialType" : String,
      "Brand" : String,
      "CapabilityReport" : CapabilityReport,
      "Classification" : String,
      "CredentialLockerId" : String,
      "MetaData" : {Key: Value, ...},
      "Model" : String,
      "Name" : String,
      "Owner" : String,
      "Role" : String,
      "SerialNumber" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::IoTManagedIntegrations::ManagedThing
Properties:
  AuthenticationMaterial: String
  AuthenticationMaterialType: String
  Brand: String
  CapabilityReport: 
    CapabilityReport
  Classification: String
  CredentialLockerId: String
  MetaData: 
    Key: Value
  Model: String
  Name: String
  Owner: String
  Role: String
  SerialNumber: String
  Tags: 
    Key: Value

Properties

AuthenticationMaterial

The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

Required: No

Type: String

Pattern: ^[0-9A-Za-z!#$%&()*\+\-;<=>?@^_`{|}~\/: ]+$

Minimum: 1

Maximum: 512

Update requires: Replacement

AuthenticationMaterialType

The type of authentication material used for device connectivity setup requests.

Required: No

Type: String

Allowed values: WIFI_SETUP_QR_BAR_CODE | ZWAVE_QR_BAR_CODE | ZIGBEE_QR_BAR_CODE

Update requires: Replacement

Brand

The brand of the device.

Required: No

Type: String

Pattern: ^[A-Za-z0-9-_ ]+$

Minimum: 1

Maximum: 128

Update requires: No interruption

CapabilityReport

A report of the capabilities for the managed thing.

Required: No

Type: CapabilityReport

Update requires: No interruption

Classification

The classification of the managed thing such as light bulb or thermostat.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

CredentialLockerId

The identifier of the credential locker for the managed thing.

Required: No

Type: String

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

Minimum: 1

Maximum: 64

Update requires: No interruption

MetaData

The metadata for the managed thing.

Note

The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air (OTA) tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.

Required: No

Type: Object of String

Pattern: [a-zA-Z0-9_.,@/:#-]+

Maximum: 800

Update requires: No interruption

Model

The model of the device.

Required: No

Type: String

Pattern: ^[A-Za-z0-9-_ ]+$

Minimum: 1

Maximum: 128

Update requires: No interruption

Name

The name of the managed thing representing the physical device.

Required: No

Type: String

Pattern: ^[A-Za-z]+$

Minimum: 1

Maximum: 128

Update requires: No interruption

Owner

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_.,@-]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

Role

The type of device used. This will be the hub controller, cloud device, or IoT device.

Required: Yes

Type: String

Allowed values: CONTROLLER | DEVICE

Update requires: Replacement

SerialNumber

The serial number of the device.

Required: No

Type: String

Pattern: ^[A-Za-z0-9-_ ]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Tags

A set of key/value pairs that are used to manage the managed thing.

Required: No

Type: Object of String

Pattern: .+

Minimum: 0

Maximum: 256

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the managed thing name.

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.

Arn

The Amazon Resource Name (ARN) of the managed thing.

CreatedAt

The timestamp value of when the device creation request occurred.

Id

The id of the managed thing.

Identifier

The id of the managed thing.

ProvisioningStatus

The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

UniversalProductCode

The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.

UpdatedAt

The timestamp value of when the managed thing was last updated at.