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	awscc.robomaker.robots

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::RoboMaker::Robot.

Methods

Name	Resource	Accessible by	Required Params
create_resource	robots	INSERT	GreengrassGroupId, Architecture, region
delete_resource	robots	DELETE	Identifier, region
update_resource	robots	UPDATE	Identifier, PatchDocument, region
list_resources	robots_list_only	SELECT	region
get_resource	robots	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual robot.

SELECT
  region,
  arn,
  fleet,
  architecture,
  greengrass_group_id,
  tags,
  name
FROM awscc.robomaker.robots
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all robots in a region.

SELECT
  region,
  arn
FROM awscc.robomaker.robots_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.robomaker.robots (
  Fleet,
  Architecture,
  GreengrassGroupId,
  Tags,
  Name,
  region
)
SELECT
  '{{ fleet }}',
  '{{ architecture }}',
  '{{ greengrass_group_id }}',
  '{{ 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: greengrass_group_id
        value: '{{ greengrass_group_id }}'
      - name: tags
        value: {}
      - name: name
        value: '{{ name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.robomaker.robots
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.robomaker.robots
WHERE
  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