robot_applications

Creates, updates, deletes or gets a robot_application resource or lists robot_applications in a region

Overview

Name	robot_applications
Type	Resource
Description	This schema is for testing purpose only.
Id	aws.robomaker.robot_applications

Fields

Name	Datatype	Description
name	string	The name of the robot application.
sources	array	The sources of the robot application.
environment	string	The URI of the Docker image for the robot application.
robot_software_suite	object	Information about a robot software suite.
current_revision_id	string	The revision ID of robot application.
arn	string
tags	object	A key-value pair to associate with a resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RobotSoftwareSuite, 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 robot_applications in a region.

SELECT
region,
name,
sources,
environment,
robot_software_suite,
current_revision_id,
arn,
tags
FROM aws.robomaker.robot_applications
WHERE region = 'us-east-1';

Gets all properties from an individual robot_application.

SELECT
region,
name,
sources,
environment,
robot_software_suite,
current_revision_id,
arn,
tags
FROM aws.robomaker.robot_applications
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.robomaker.robot_applications (
 RobotSoftwareSuite,
 region
)
SELECT 
'{{ RobotSoftwareSuite }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.robomaker.robot_applications (
 Name,
 Sources,
 Environment,
 RobotSoftwareSuite,
 CurrentRevisionId,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Sources }}',
 '{{ Environment }}',
 '{{ RobotSoftwareSuite }}',
 '{{ CurrentRevisionId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: robot_application
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Sources
        value:
          - S3Bucket: '{{ S3Bucket }}'
            S3Key: '{{ S3Key }}'
            Architecture: '{{ Architecture }}'
      - name: Environment
        value: '{{ Environment }}'
      - name: RobotSoftwareSuite
        value:
          Name: '{{ Name }}'
          Version: '{{ Version }}'
      - name: CurrentRevisionId
        value: '{{ CurrentRevisionId }}'
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

robomaker:CreateRobotApplication,
robomaker:TagResource,
robomaker:UntagResource,
ecr:BatchGetImage,
ecr:GetAuthorizationToken,
ecr:BatchCheckLayerAvailability,
ecr-public:GetAuthorizationToken,
sts:GetServiceBearerToken

Read

robomaker:DescribeRobotApplication

Update

robomaker:TagResource,
robomaker:UntagResource,
robomaker:UpdateRobotApplication,
ecr:BatchGetImage,
ecr:GetAuthorizationToken,
ecr:BatchCheckLayerAvailability,
ecr-public:GetAuthorizationToken

Delete

robomaker:DescribeRobotApplication,
robomaker:DeleteRobotApplication

List

robomaker:ListRobotApplications