CfnSyncJobProps

class aws_cdk.aws_iottwinmaker.CfnSyncJobProps(*, sync_role, sync_source, workspace_id, tags=None)

Bases: object

Properties for defining a CfnSyncJob.

Parameters:
  • sync_role (str) – 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.

  • sync_source (str) – The sync source. .. epigraph:: Currently the only supported syncSoucre is SITEWISE .

  • workspace_id (str) – The ID of the workspace that contains the sync job.

  • tags (Optional[Mapping[str, str]]) – Metadata you can use to manage the SyncJob.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker

cfn_sync_job_props = iottwinmaker.CfnSyncJobProps(
    sync_role="syncRole",
    sync_source="syncSource",
    workspace_id="workspaceId",

    # the properties below are optional
    tags={
        "tags_key": "tags"
    }
)

Attributes

sync_role

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:

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

sync_source

The sync source.

Currently the only supported syncSoucre is SITEWISE .

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.

See:

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

workspace_id

The ID of the workspace that contains the sync job.

See:

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