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	awscc.simspaceweaver.simulations

Fields

get (all properties)

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.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the simulation.
region	string	AWS region.

For more information, see AWS::SimSpaceWeaver::Simulation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	simulations	INSERT	Name, RoleArn, region
delete_resource	simulations	DELETE	Identifier, region
update_resource	simulations	UPDATE	Identifier, PatchDocument, region
list_resources	simulations_list_only	SELECT	region
get_resource	simulations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual simulation.

SELECT
  region,
  name,
  role_arn,
  schema_s3_location,
  describe_payload,
  maximum_duration,
  snapshot_s3_location
FROM awscc.simspaceweaver.simulations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all simulations in a region.

SELECT
  region,
  name
FROM awscc.simspaceweaver.simulations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.simspaceweaver.simulations (
  Name,
  RoleArn,
  region
)
SELECT
  '{{ name }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.simspaceweaver.simulations (
  Name,
  RoleArn,
  SchemaS3Location,
  MaximumDuration,
  SnapshotS3Location,
  region
)
SELECT
  '{{ name }}',
  '{{ role_arn }}',
  '{{ schema_s3_location }}',
  '{{ maximum_duration }}',
  '{{ snapshot_s3_location }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: role_arn
      value: '{{ role_arn }}'
    - name: schema_s3_location
      value:
        bucket_name: '{{ bucket_name }}'
        object_key: '{{ object_key }}'
    - name: maximum_duration
      value: '{{ maximum_duration }}'
    - name: snapshot_s3_location
      value: null

DELETE example

/*+ delete */
DELETE FROM awscc.simspaceweaver.simulations
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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