AWS CloudFormation
User Guide (Version )

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

AWS::RoboMaker::Robot

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

Syntax

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

JSON

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

YAML

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

Properties

Architecture

The architecture of the robot.

Required: Yes

Type: String

Allowed Values: ARM64 | ARMHF | X86_64

Update requires: Replacement

Fleet

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

Required: No

Type: String

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

Pattern: [a-zA-Z0-9_\-]*

Update requires: Replacement

Tags

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

Required: No

Type: Json

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.

Examples

Create an AWS 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