simulation_applications

Creates, updates, deletes or gets a simulation_application resource or lists simulation_applications in a region

Overview

Name	simulation_applications
Type	Resource
Description	This schema is for testing purpose only.
Id	awscc.robomaker.simulation_applications

Fields

get (all properties)

Name	Datatype	Description
arn	string
name	string	The name of the simulation application.
current_revision_id	string	The current revision id.
▶rendering_engine	object	The rendering engine for the simulation application.
▶robot_software_suite	object	The robot software suite used by the simulation application.
▶simulation_software_suite	object	The simulation software suite used by the simulation application.
▶sources	array	The sources of the simulation application.
environment	string	The URI of the Docker image for the robot application.
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::SimulationApplication.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual simulation_application.

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

list (identifiers only)

Lists all simulation_applications in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.robomaker.simulation_applications (
  RobotSoftwareSuite,
  SimulationSoftwareSuite,
  region
)
SELECT
  '{{ robot_software_suite }}',
  '{{ simulation_software_suite }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.robomaker.simulation_applications (
  Name,
  CurrentRevisionId,
  RenderingEngine,
  RobotSoftwareSuite,
  SimulationSoftwareSuite,
  Sources,
  Environment,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ current_revision_id }}',
  '{{ rendering_engine }}',
  '{{ robot_software_suite }}',
  '{{ simulation_software_suite }}',
  '{{ sources }}',
  '{{ environment }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: simulation_application
    props:
      - name: name
        value: '{{ name }}'
      - name: current_revision_id
        value: '{{ current_revision_id }}'
      - name: rendering_engine
        value:
          name: '{{ name }}'
          version: '{{ version }}'
      - name: robot_software_suite
        value:
          name: '{{ name }}'
          version: '{{ version }}'
      - name: simulation_software_suite
        value:
          name: '{{ name }}'
          version: '{{ version }}'
      - name: sources
        value:
          - s3_bucket: '{{ s3_bucket }}'
            s3_key: '{{ s3_key }}'
            architecture: '{{ architecture }}'
      - name: environment
        value: '{{ environment }}'
      - name: tags
        value: {}

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.robomaker.simulation_applications
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

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

Read

robomaker:DescribeSimulationApplication

Update

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

Delete

robomaker:DescribeSimulationApplication,
robomaker:DeleteSimulationApplication

List

robomaker:ListSimulationApplications