Skip to content
v2.275.0

CfnSyncJobProps Struct ​

Properties for defining a CfnSyncJob.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iottwinmaker as iottwinmaker } from 'aws-cdk-lib';
const cfnSyncJobProps: iottwinmaker.CfnSyncJobProps = {
  syncRole: 'syncRole',
  syncSource: 'syncSource',
  workspaceId: 'workspaceId',

  // the properties below are optional
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

syncRolestringsync_rolestrsyncRoleStringSyncRolestringSyncRole*stringrequired#
The SyncJob IAM role.

This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.

syncSourcestringsync_sourcestrsyncSourceStringSyncSourcestringSyncSource*stringrequired#
The sync source.

Currently the only supported syncSoucre is SITEWISE .

tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Metadata you can use to manage the SyncJob.
workspaceIdstringworkspace_idstrworkspaceIdStringWorkspaceIdstringWorkspaceId*stringrequired#
The ID of the workspace that contains the sync job.