CfnSyncJobMixinProps

class aws_cdk.mixins_preview.aws_iottwinmaker.mixins.CfnSyncJobMixinProps(*, sync_role=None, sync_source=None, tags=None, workspace_id=None)

Bases: object

Properties for CfnSyncJobPropsMixin.

Parameters:
  • sync_role (Optional[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 (Optional[str]) – The sync source. .. epigraph:: Currently the only supported syncSoucre is SITEWISE .

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

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

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.mixins_preview.aws_iottwinmaker import mixins as iottwinmaker_mixins

cfn_sync_job_mixin_props = iottwinmaker_mixins.CfnSyncJobMixinProps(
    sync_role="syncRole",
    sync_source="syncSource",
    tags={
        "tags_key": "tags"
    },
    workspace_id="workspaceId"
)

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