Package software.amazon.awscdk.services.iottwinmaker

Class CfnSyncJob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iottwinmaker.CfnSyncJob
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISyncJobRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.568Z") @Stability(Stable) public class CfnSyncJob extends CfnResource implements IInspectable, ISyncJobRef, ITaggable
The SyncJob.

Example: 

 // 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.*;
 CfnSyncJob cfnSyncJob = CfnSyncJob.Builder.create(this, "MyCfnSyncJob")
         .syncRole("syncRole")
         .syncSource("syncSource")
         .workspaceId("workspaceId")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSyncJob

      protected CfnSyncJob(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSyncJob

      protected CfnSyncJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSyncJob

      @Stability(Stable) public CfnSyncJob(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSyncJobProps props)
      Create a new AWS::IoTTwinMaker::SyncJob.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSyncJob

      @Stability(Stable) @NotNull public static String arnForSyncJob(@NotNull ISyncJobRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSyncJob

      @Stability(Stable) @NotNull public static Boolean isCfnSyncJob(@NotNull Object x)
      Checks whether the given object is a CfnSyncJob.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The SyncJob ARN.

    • getAttrCreationDateTime

      @Stability(Stable) @NotNull public String getAttrCreationDateTime()
      The creation date and time of the SyncJob.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The SyncJob's state.

    • getAttrUpdateDateTime

      @Stability(Stable) @NotNull public String getAttrUpdateDateTime()
      The update date and time.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSyncJobRef

      @Stability(Stable) @NotNull public SyncJobReference getSyncJobRef()
      A reference to a SyncJob resource.
      Specified by:
      getSyncJobRef in interface ISyncJobRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getSyncRole

      @Stability(Stable) @NotNull public String getSyncRole()
      The SyncJob IAM role.

    • setSyncRole

      @Stability(Stable) public void setSyncRole(@NotNull String value)
      The SyncJob IAM role.

    • getSyncSource

      @Stability(Stable) @NotNull public String getSyncSource()
      The sync source.

    • setSyncSource

      @Stability(Stable) public void setSyncSource(@NotNull String value)
      The sync source.

    • getWorkspaceId

      @Stability(Stable) @NotNull public String getWorkspaceId()
      The ID of the workspace that contains the sync job.

    • setWorkspaceId

      @Stability(Stable) public void setWorkspaceId(@NotNull String value)
      The ID of the workspace that contains the sync job.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      Metadata you can use to manage the SyncJob.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      Metadata you can use to manage the SyncJob.