Package software.amazon.awscdk.services.iottwinmaker

Class CfnSyncJob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iottwinmaker.CfnSyncJob
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.970Z") @Stability(Stable) public class CfnSyncJob extends CfnResource implements IInspectable
A CloudFormation AWS::IoTTwinMaker::SyncJob.

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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata you can use to manage the SyncJob.

    • getSyncRole

      @Stability(Stable) @NotNull public 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.

    • setSyncRole

      @Stability(Stable) public void setSyncRole(@NotNull String value)
      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.

    • getSyncSource

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

      Currently the only supported syncSoucre is SITEWISE .

    • setSyncSource

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

      Currently the only supported syncSoucre is SITEWISE .

    • 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.