simulations

Creates, updates, deletes or gets a simulation resource or lists simulations in a region

Overview

Name	simulations
Type	Resource
Description	AWS::SimSpaceWeaver::Simulation resource creates an AWS Simulation.
Id	aws.simspaceweaver.simulations

Fields

Name	Datatype	Description
name	string	The name of the simulation.
role_arn	string	Role ARN.
schema_s3_location	object
describe_payload	string	Json object with all simulation details
maximum_duration	string	The maximum running time of the simulation.
snapshot_s3_location	object
region	string	AWS region.

Methods

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

SELECT
region,
name,
role_arn,
schema_s3_location,
describe_payload,
maximum_duration,
snapshot_s3_location
FROM aws.simspaceweaver.simulations
WHERE region = 'us-east-1';

Gets all properties from an individual simulation.

SELECT
region,
name,
role_arn,
schema_s3_location,
describe_payload,
maximum_duration,
snapshot_s3_location
FROM aws.simspaceweaver.simulations
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.simspaceweaver.simulations (
 Name,
 RoleArn,
 region
)
SELECT 
'{{ Name }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.simspaceweaver.simulations (
 Name,
 RoleArn,
 SchemaS3Location,
 MaximumDuration,
 SnapshotS3Location,
 region
)
SELECT 
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ SchemaS3Location }}',
 '{{ MaximumDuration }}',
 '{{ SnapshotS3Location }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: simulation
    props:
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: SchemaS3Location
        value:
          BucketName: '{{ BucketName }}'
          ObjectKey: '{{ ObjectKey }}'
      - name: MaximumDuration
        value: '{{ MaximumDuration }}'
      - name: SnapshotS3Location
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.simspaceweaver.simulations
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

simspaceweaver:StartSimulation,
simspaceweaver:DescribeSimulation,
iam:GetRole,
iam:PassRole

Read

simspaceweaver:DescribeSimulation

Update

simspaceweaver:StartSimulation,
simspaceweaver:StopSimulation,
simspaceweaver:DeleteSimulation,
simspaceweaver:DescribeSimulation

Delete

simspaceweaver:StopSimulation,
simspaceweaver:DeleteSimulation,
simspaceweaver:DescribeSimulation

List

simspaceweaver:ListSimulations