Interface ICfnSyncJobProps

Properties for defining a CfnSyncJob.

Namespace: Amazon.CDK.AWS.IoTTwinMaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnSyncJobProps

Syntax (vb)

Public Interface ICfnSyncJobProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTTwinMaker;

             var cfnSyncJobProps = new CfnSyncJobProps {
                 SyncRole = "syncRole",
                 SyncSource = "syncSource",
                 WorkspaceId = "workspaceId",

                 // the properties below are optional
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Properties

SyncRole	The SyncJob IAM role.
SyncSource	The sync source.
Tags	Metadata you can use to manage the SyncJob.
WorkspaceId	The ID of the workspace that contains the sync job.

Properties

SyncRole

The SyncJob IAM role.

string SyncRole { get; }

Property Value

string

Remarks

This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.

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

SyncSource

The sync source.

string SyncSource { get; }

Property Value

string

Remarks

Currently the only supported syncSoucre is <code>SITEWISE</code> .

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

WorkspaceId

The ID of the workspace that contains the sync job.

string WorkspaceId { get; }

Property Value

string

Remarks

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