Show / Hide Table of Contents

Class CfnSyncJobProps

Properties for defining a CfnSyncJob.

Inheritance
object
CfnSyncJobProps
Implements
ICfnSyncJobProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.IoTTwinMaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSyncJobProps : ICfnSyncJobProps
Syntax (vb)
Public Class CfnSyncJobProps Implements 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

Constructors

CfnSyncJobProps()

Properties for defining a CfnSyncJob.

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.

Constructors

CfnSyncJobProps()

Properties for defining a CfnSyncJob.

public CfnSyncJobProps()
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" }
                 }
             };

Properties

SyncRole

The SyncJob IAM role.

public string SyncRole { get; set; }
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.

public string SyncSource { get; set; }
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

Tags

Metadata you can use to manage the SyncJob.

public IDictionary<string, string>? Tags { get; set; }
Property Value

IDictionary<string, string>

Remarks

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

WorkspaceId

The ID of the workspace that contains the sync job.

public string WorkspaceId { get; set; }
Property Value

string

Remarks

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

Implements

ICfnSyncJobProps
Back to top Generated by DocFX