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	aws.robomaker.simulation_applications

Fields

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.

Methods

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

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

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 aws.robomaker.simulation_applications
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.robomaker.simulation_applications (
 RobotSoftwareSuite,
 SimulationSoftwareSuite,
 region
)
SELECT 
'{{ RobotSoftwareSuite }}',
 '{{ SimulationSoftwareSuite }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.robomaker.simulation_applications (
 Name,
 CurrentRevisionId,
 RenderingEngine,
 RobotSoftwareSuite,
 SimulationSoftwareSuite,
 Sources,
 Environment,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ CurrentRevisionId }}',
 '{{ RenderingEngine }}',
 '{{ RobotSoftwareSuite }}',
 '{{ SimulationSoftwareSuite }}',
 '{{ 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: CurrentRevisionId
        value: '{{ CurrentRevisionId }}'
      - name: RenderingEngine
        value:
          Name: '{{ Name }}'
          Version: '{{ Version }}'
      - name: RobotSoftwareSuite
        value:
          Name: '{{ Name }}'
          Version: '{{ Version }}'
      - name: SimulationSoftwareSuite
        value:
          Name: '{{ Name }}'
          Version: '{{ Version }}'
      - name: Sources
        value:
          - S3Bucket: '{{ S3Bucket }}'
            S3Key: '{{ S3Key }}'
            Architecture: '{{ Architecture }}'
      - name: Environment
        value: '{{ Environment }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.robomaker.simulation_applications
WHERE data__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