CfnSyncJobProps Struct
Properties for defining a CfnSyncJob.
| Source | |
|---|---|
| Type last changed |
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',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker
cfn_sync_job_props = iottwinmaker.CfnSyncJobProps(
sync_role="syncRole",
sync_source="syncSource",
workspace_id="workspaceId",
# the properties below are optional
tags={
"tags_key": "tags"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iottwinmaker.*;
CfnSyncJobProps cfnSyncJobProps = CfnSyncJobProps.builder()
.syncRole("syncRole")
.syncSource("syncSource")
.workspaceId("workspaceId")
// the properties below are optional
.tags(Map.of(
"tagsKey", "tags"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTTwinMaker;
var cfnSyncJobProps = new CfnSyncJobProps {
SyncRole = "syncRole",
SyncSource = "syncSource",
WorkspaceId = "workspaceId",
// the properties below are optional
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSyncJobProps := &CfnSyncJobProps{
SyncRole: jsii.String("syncRole"),
SyncSource: jsii.String("syncSource"),
WorkspaceId: jsii.String("workspaceId"),
// the properties below are optional
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
Properties
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.
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.
The ID of the workspace that contains the sync job.