AWS::IoTTwinMaker::SyncJob
The SyncJob.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoTTwinMaker::SyncJob", "Properties" : { "SyncRole" :
String
, "SyncSource" :String
, "Tags" :{
, "WorkspaceId" :Key
:Value
, ...}String
} }
YAML
Type: AWS::IoTTwinMaker::SyncJob Properties: SyncRole:
String
SyncSource:String
Tags:WorkspaceId:
Key
:Value
String
Properties
SyncRole
-
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.
Required: Yes
Type: String
Update requires: Replacement
SyncSource
The sync source.
Note Currently the only supported syncSoucre is
SITEWISE
.Required: Yes
Type: String
Update requires: Replacement
Tags
Metadata you can use to manage the SyncJob.
Required: No
Type: Map of String
Update requires: Replacement
WorkspaceId
The ID of the workspace that contains the sync job.
Required: Yes
Type: String
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the workspace Id and the entity Id.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.