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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	robot_applications	INSERT	RobotSoftwareSuite, region
delete_resource	robot_applications	DELETE	Identifier, region
update_resource	robot_applications	UPDATE	Identifier, PatchDocument, region
list_resources	robot_applications_list_only	SELECT	region
get_resource	robot_applications	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual robot_application.

SELECT
  region,
  name,
  sources,
  environment,
  robot_software_suite,
  current_revision_id,
  arn,
  tags
FROM awscc.robomaker.robot_applications
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all robot_applications in a region.

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

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 awscc.robomaker.robot_applications (
  RobotSoftwareSuite,
  region
)
SELECT
  '{{ robot_software_suite }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.robomaker.robot_applications (
  Name,
  Sources,
  Environment,
  RobotSoftwareSuite,
  CurrentRevisionId,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ sources }}',
  '{{ environment }}',
  '{{ robot_software_suite }}',
  '{{ current_revision_id }}',
  '{{ 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:
          - s3_bucket: '{{ s3_bucket }}'
            s3_key: '{{ s3_key }}'
            architecture: '{{ architecture }}'
      - name: environment
        value: '{{ environment }}'
      - name: robot_software_suite
        value:
          name: '{{ name }}'
          version: '{{ version }}'
      - name: current_revision_id
        value: '{{ current_revision_id }}'
      - name: tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.robomaker.robot_applications
SET PatchDocument = string('{{ {
    "Sources": sources,
    "Environment": environment,
    "RobotSoftwareSuite": robot_software_suite,
    "CurrentRevisionId": current_revision_id,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

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