aws-cdk-lib.aws_iottwinmaker.CfnSyncJobProps

interface CfnSyncJobProps

LanguageType name
.NETAmazon.CDK.AWS.IoTTwinMaker.CfnSyncJobProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnSyncJobProps
Javasoftware.amazon.awscdk.services.iottwinmaker.CfnSyncJobProps
Pythonaws_cdk.aws_iottwinmaker.CfnSyncJobProps
TypeScript aws-cdk-lib » aws_iottwinmaker » CfnSyncJobProps

Properties for defining a CfnSyncJob.

Example

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

NameTypeDescription
syncRolestringThe SyncJob IAM role.
syncSourcestringThe sync source.
workspaceIdstringThe ID of the workspace that contains the sync job.
tags?{ [string]: string }Metadata you can use to manage the SyncJob.

syncRole

Type: string

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.


syncSource

Type: string

The sync source.

Currently the only supported syncSoucre is SITEWISE .


workspaceId

Type: string

The ID of the workspace that contains the sync job.


tags?

Type: { [string]: string } (optional)

Metadata you can use to manage the SyncJob.