AWS::RoboMaker::Robot - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
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::RoboMaker::Robot

Important

The following resource is now deprecated. This resource can no longer be provisioned via stack create or update operations, and should not be included in your stack templates.

We recommend migrating to Amazon IoT Greengrass Version 2. For more information, see Support Changes: May 2, 2022 in the Amazon RoboMaker Developer Guide.

The AWS::RoboMaker::RobotApplication resource creates an Amazon RoboMaker robot.

Syntax

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

JSON

{
  "Type" : "AWS::RoboMaker::Robot",
  "Properties" : {
      "Architecture" : String,
      "Fleet" : String,
      "GreengrassGroupId" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::RoboMaker::Robot
Properties:
  Architecture: String
  Fleet: String
  GreengrassGroupId: String
  Name: String
  Tags: 
    Key: Value

Properties

Architecture

The architecture of the robot.

Required: Yes

Type: String

Allowed values: X86_64 | ARM64 | ARMHF

Update requires: Replacement

Fleet

The Amazon Resource Name (ARN) of the fleet to which the robot will be registered.

Required: No

Type: String

Minimum: 1

Maximum: 1224

Update requires: Replacement

GreengrassGroupId

The Greengrass group associated with the robot.

Required: Yes

Type: String

Minimum: 1

Maximum: 1224

Update requires: Replacement

Name

The name of the robot.

Required: No

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

A map that contains tag keys and tag values that are attached to the robot.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9-]{1,128}$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of an AWS::RoboMaker::Robot resource to the intrinsic Ref function, the function returns the Amazon Resource Name (ARN) of the robot application, such as arn:aws:robomaker:us-west-2:123456789012:robot/MyRobot/1544035373264.

For more information about using the Ref function, see Ref.

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

Examples

Create an Amazon RoboMaker Robot

The following example creates a robot.

JSON

{
  "Description": "RoboMaker Robot example",
  "Resources": {
    "BasicFleet": {
      "Type": "AWS::RoboMaker::Fleet",
      "Properties": {
        "Name": "MyFleet"
      }
    },
    "BasicRobot": {
      "Type": "AWS::RoboMaker::Robot",
      "Properties": {
        "Name": "MyRobot",
        "GreengrassGroupId": "51229986-abdc-4ca6-94f8-04735a0c9f07",
        "Architecture": "ARMHF",
        "Fleet": { 
          "Fn::GetAtt" : [ "BasicFleet", "Arn" ] 
        },
        "Tags": {
          "Name": "BasicRobot",
          "Type": "CFN"
        }
      }
    }
  },
  "Outputs": {
    "Robot": {
      "Value": "BasicRobot"
    }
  }
}

YAML

---
Description: "RoboMaker Robot example"
Resources:
  BasicFleet:
    Type: "AWS::RoboMaker::Fleet"
    Properties:
      Name: "MyFleet"
  BasicRobot:
    Type: "AWS::RoboMaker::Robot"
    Properties:
      Name: "MyRobot"
      GreengrassGroupId: "51229986-abdc-4ca6-94f8-04735a0c9f07"
      Architecture: "ARMHF"
      Fleet: !GetAtt BasicFleet.Arn
      Tags:
        "Name" : "BasicRobot"
        "Type" : "CFN"
Outputs:
  Robot:
    Value: !Ref BasicRobot