Package software.amazon.awscdk.services.iottwinmaker

Class CfnSyncJob.Builder

java.lang.Object

software.amazon.awscdk.services.iottwinmaker.CfnSyncJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSyncJob>

Enclosing class:

CfnSyncJob

@Stability(Stable)
public static final class CfnSyncJob.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSyncJob>

A fluent builder for CfnSyncJob.

Method Summary

Modifier and Type	Method	Description
CfnSyncJob	build()
static CfnSyncJob.Builder	create(software.constructs.Construct scope, String id)
CfnSyncJob.Builder	syncRole(String syncRole)	The SyncJob IAM role.
CfnSyncJob.Builder	syncSource(String syncSource)	The sync source.
CfnSyncJob.Builder	tags(Map<String,String> tags)	Metadata you can use to manage the SyncJob.
CfnSyncJob.Builder	workspaceId(String workspaceId)	The ID of the workspace that contains the sync job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnSyncJob.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnSyncJob.Builder.

syncRole

@Stability(Stable)
public CfnSyncJob.Builder syncRole(String syncRole)

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.

Parameters:

syncRole - The SyncJob IAM role. This parameter is required.

Returns:

this

See Also:

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

syncSource

@Stability(Stable)
public CfnSyncJob.Builder syncSource(String syncSource)

The sync source.

Currently the only supported syncSoucre is SITEWISE .

Parameters:

syncSource - The sync source. This parameter is required.

Returns:

this

See Also:

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

workspaceId

@Stability(Stable)
public CfnSyncJob.Builder workspaceId(String workspaceId)

The ID of the workspace that contains the sync job.

Parameters:

workspaceId - The ID of the workspace that contains the sync job. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSyncJob.Builder tags(Map<String,String> tags)

Metadata you can use to manage the SyncJob.

Parameters:

tags - Metadata you can use to manage the SyncJob. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSyncJob build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSyncJob>

Returns:

a newly built instance of CfnSyncJob.