Package software.amazon.awscdk.services.iottwinmaker

Interface CfnSyncJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSyncJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.656Z")
@Stability(Stable)
public interface CfnSyncJobProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSyncJob.

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.*;
 CfnSyncJobProps cfnSyncJobProps = CfnSyncJobProps.builder()
         .syncRole("syncRole")
         .syncSource("syncSource")
         .workspaceId("workspaceId")
         // the properties below are optional
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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	CfnSyncJobProps.Builder	A builder for CfnSyncJobProps
static final class	CfnSyncJobProps.Jsii$Proxy	An implementation for CfnSyncJobProps

Method Summary

Modifier and Type	Method	Description
static CfnSyncJobProps.Builder	builder()
String	getSyncRole()	The SyncJob IAM role.
String	getSyncSource()	The sync source.
default Map<String,String>	getTags()	Metadata you can use to manage the SyncJob.
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)
@NotNull
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)
@NotNull
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

getWorkspaceId

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

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

builder

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

Returns:

a CfnSyncJobProps.Builder of CfnSyncJobProps