robots

Creates, updates, deletes or gets a robot resource or lists robots in a region

Overview

Name	robots
Type	Resource
Description	AWS::RoboMaker::Robot resource creates an AWS RoboMaker Robot.
Id	aws.robomaker.robots

Fields

Name	Datatype	Description
arn	string
fleet	string	The Amazon Resource Name (ARN) of the fleet.
architecture	string	The target architecture of the robot.
greengrass_group_id	string	The Greengrass group id.
tags	object	A key-value pair to associate with a resource.
name	string	The name for the robot.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GreengrassGroupId, Architecture, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all robots in a region.

SELECT
region,
arn,
fleet,
architecture,
greengrass_group_id,
tags,
name
FROM aws.robomaker.robots
WHERE region = 'us-east-1';

Gets all properties from an individual robot.

SELECT
region,
arn,
fleet,
architecture,
greengrass_group_id,
tags,
name
FROM aws.robomaker.robots
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new robot resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.robomaker.robots (
 Architecture,
 GreengrassGroupId,
 region
)
SELECT 
'{{ Architecture }}',
 '{{ GreengrassGroupId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.robomaker.robots (
 Fleet,
 Architecture,
 GreengrassGroupId,
 Tags,
 Name,
 region
)
SELECT 
 '{{ Fleet }}',
 '{{ Architecture }}',
 '{{ GreengrassGroupId }}',
 '{{ Tags }}',
 '{{ Name }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: robot
    props:
      - name: Fleet
        value: '{{ Fleet }}'
      - name: Architecture
        value: '{{ Architecture }}'
      - name: GreengrassGroupId
        value: '{{ GreengrassGroupId }}'
      - name: Tags
        value: {}
      - name: Name
        value: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.robomaker.robots
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the robots resource, the following permissions are required:

Create

robomaker:CreateRobot,
robomaker:RegisterRobot

Read

robomaker:DescribeRobot

Delete

robomaker:DescribeRobot,
robomaker:DeleteRobot,
robomaker:DeregisterRobot

List

robomaker:ListRobots

Update

robomaker:TagResource,
robomaker:UntagResource