sync_jobs

Creates, updates, deletes or gets a sync_job resource or lists sync_jobs in a region

Overview

Name	sync_jobs
Type	Resource
Description	Resource schema for AWS::IoTTwinMaker::SyncJob
Id	aws.iottwinmaker.sync_jobs

Fields

Name	Datatype	Description
workspace_id	string	The ID of the workspace.
sync_source	string	The source of the SyncJob.
sync_role	string	The IAM Role that execute SyncJob.
creation_date_time	string	The date and time when the sync job was created.
update_date_time	string	The date and time when the sync job was updated.
arn	string	The ARN of the SyncJob.
state	string	The state of SyncJob.
tags	object	A key-value pair to associate with a resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	WorkspaceId, SyncSource, SyncRole, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all sync_jobs in a region.

SELECT
region,
workspace_id,
sync_source,
sync_role,
creation_date_time,
update_date_time,
arn,
state,
tags
FROM aws.iottwinmaker.sync_jobs
WHERE region = 'us-east-1';

Gets all properties from an individual sync_job.

SELECT
region,
workspace_id,
sync_source,
sync_role,
creation_date_time,
update_date_time,
arn,
state,
tags
FROM aws.iottwinmaker.sync_jobs
WHERE region = 'us-east-1' AND data__Identifier = '<WorkspaceId>|<SyncSource>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iottwinmaker.sync_jobs (
 WorkspaceId,
 SyncSource,
 SyncRole,
 region
)
SELECT 
'{{ WorkspaceId }}',
 '{{ SyncSource }}',
 '{{ SyncRole }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iottwinmaker.sync_jobs (
 WorkspaceId,
 SyncSource,
 SyncRole,
 Tags,
 region
)
SELECT 
 '{{ WorkspaceId }}',
 '{{ SyncSource }}',
 '{{ SyncRole }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: sync_job
    props:
      - name: WorkspaceId
        value: '{{ WorkspaceId }}'
      - name: SyncSource
        value: '{{ SyncSource }}'
      - name: SyncRole
        value: '{{ SyncRole }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.iottwinmaker.sync_jobs
WHERE data__Identifier = '<WorkspaceId|SyncSource>'
AND region = 'us-east-1';

Permissions

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

Create

iam:PassRole,
iottwinmaker:CreateSyncJob,
iottwinmaker:GetSyncJob,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource,
iottwinmaker:TagResource

Read

iottwinmaker:GetSyncJob,
iottwinmaker:GetWorkspace,
iottwinmaker:ListTagsForResource

Delete

iottwinmaker:DeleteSyncJob,
iottwinmaker:GetSyncJob,
iottwinmaker:GetWorkspace

List

iottwinmaker:GetWorkspace,
iottwinmaker:ListSyncJobs,
iottwinmaker:ListTagsForResource