Class: AWSCDK::IoTTwinMaker::CfnSyncJobProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_twin_maker/cfn_sync_job_props.rb

Overview

Properties for defining a CfnSyncJob.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sync_role:, sync_source:, workspace_id:, tags: nil) ⇒ CfnSyncJobProps

Returns a new instance of CfnSyncJobProps.

Parameters:

  • sync_role (String) —

    The SyncJob IAM role.

  • sync_source (String) —

    The sync source.

  • workspace_id (String) —

    The ID of the workspace that contains the sync job.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Metadata you can use to manage the SyncJob.



13
14
15
16
17
18
19
20
21
22
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 13

def initialize(sync_role:, sync_source:, workspace_id:, tags: nil)
  @sync_role = sync_role
  Jsii::Type.check_type(@sync_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "syncRole")
  @sync_source = sync_source
  Jsii::Type.check_type(@sync_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "syncSource")
  @workspace_id = workspace_id
  Jsii::Type.check_type(@workspace_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#sync_role ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



30
31
32
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 30

def sync_role
  @sync_role
end

#sync_source ⇒ String (readonly)

The sync source.

Currently the only supported syncSoucre is SITEWISE .

Returns:

  • (String)

See Also:



37
38
39
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 37

def sync_source
  @sync_source
end

#tags ⇒ Hash{String => String}? (readonly)

Metadata you can use to manage the SyncJob.

Returns:

  • (Hash{String => String}, nil)

See Also:



47
48
49
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 47

def tags
  @tags
end

#workspace_id ⇒ String (readonly)

The ID of the workspace that contains the sync job.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 42

def workspace_id
  @workspace_id
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 49

def self.jsii_properties
  {
    :sync_role => "syncRole",
    :sync_source => "syncSource",
    :workspace_id => "workspaceId",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'io_t_twin_maker/cfn_sync_job_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "syncRole" => @sync_role,
    "syncSource" => @sync_source,
    "workspaceId" => @workspace_id,
    "tags" => @tags,
  })
  result.compact
end