Package software.amazon.awscdk.cfnpropertymixins.services.iottwinmaker

Interface CfnSyncJobMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSyncJobMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.508Z")
@Stability(Stable)
public interface CfnSyncJobMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnSyncJobPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iottwinmaker.*;
 CfnSyncJobMixinProps cfnSyncJobMixinProps = CfnSyncJobMixinProps.builder()
         .syncRole("syncRole")
         .syncSource("syncSource")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .workspaceId("workspaceId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSyncJobMixinProps.Builder	A builder for CfnSyncJobMixinProps
static final class	CfnSyncJobMixinProps.Jsii$Proxy	An implementation for CfnSyncJobMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnSyncJobMixinProps.Builder	builder()
default String	getSyncRole()	The SyncJob IAM role.
default String	getSyncSource()	The sync source.
default Map<String,String>	getTags()	Metadata you can use to manage the SyncJob.
default String	getWorkspaceId()	The ID of the workspace that contains the sync job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSyncRole

@Stability(Stable)
@Nullable
default String getSyncRole()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-syncrole

getSyncSource

@Stability(Stable)
@Nullable
default String getSyncSource()

The sync source.

Currently the only supported syncSoucre is SITEWISE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-syncsource

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Metadata you can use to manage the SyncJob.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-tags

getWorkspaceId

@Stability(Stable)
@Nullable
default String getWorkspaceId()

The ID of the workspace that contains the sync job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-syncjob.html#cfn-iottwinmaker-syncjob-workspaceid

builder

@Stability(Stable)
static CfnSyncJobMixinProps.Builder builder()

Returns:

a CfnSyncJobMixinProps.Builder of CfnSyncJobMixinProps