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	awscc.iottwinmaker.sync_jobs

Fields

get (all properties)

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.
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.

list (identifiers only)

Name	Datatype	Description
workspace_id	string	The ID of the workspace.
sync_source	string	The source of the SyncJob.
region	string	AWS region.

For more information, see AWS::IoTTwinMaker::SyncJob.

Methods

Name	Resource	Accessible by	Required Params
create_resource	sync_jobs	INSERT	WorkspaceId, SyncSource, SyncRole, region
delete_resource	sync_jobs	DELETE	Identifier, region
list_resources	sync_jobs_list_only	SELECT	region
get_resource	sync_jobs	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.iottwinmaker.sync_jobs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ workspace_id }}|{{ sync_source }}';

list (identifiers only)

Lists all sync_jobs in a region.

SELECT
  region,
  workspace_id,
  sync_source
FROM awscc.iottwinmaker.sync_jobs_list_only
WHERE
  region = 'us-east-1';

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 awscc.iottwinmaker.sync_jobs (
  WorkspaceId,
  SyncSource,
  SyncRole,
  region
)
SELECT
  '{{ workspace_id }}',
  '{{ sync_source }}',
  '{{ sync_role }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iottwinmaker.sync_jobs (
  WorkspaceId,
  SyncSource,
  SyncRole,
  Tags,
  region
)
SELECT
  '{{ workspace_id }}',
  '{{ sync_source }}',
  '{{ sync_role }}',
  '{{ 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: workspace_id
        value: '{{ workspace_id }}'
      - name: sync_source
        value: '{{ sync_source }}'
      - name: sync_role
        value: '{{ sync_role }}'
      - name: tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM awscc.iottwinmaker.sync_jobs
WHERE
  Identifier = '{{ workspace_id }}|{{ sync_source }}' 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