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" : {Key: Value, ...},
"WorkspaceId" : String
}
}
YAML
Type: AWS::IoTTwinMaker::SyncJob
Properties:
SyncRole: String
SyncSource: String
Tags:
Key: Value
WorkspaceId: 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
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*Minimum:
20Maximum:
2048Update requires: Replacement
SyncSource-
The sync source.
Note
Currently the only supported syncSoucre is
SITEWISE.Required: Yes
Type: String
Minimum:
1Maximum:
128Update requires: Replacement
-
Metadata you can use to manage the SyncJob.
Required: No
Type: Object of String
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Minimum:
1Maximum:
256Update requires: Replacement
WorkspaceId-
The ID of the workspace that contains the sync job.
Required: Yes
Type: String
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+Minimum:
1Maximum:
128Update 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.
Arn-
The SyncJob ARN.
CreationDateTime-
The creation date and time of the SyncJob.
State-
The SyncJob's state.
UpdateDateTime-
The update date and time.
