Class: AWSCDK::IoTSiteWise::CfnDashboardProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_site_wise/cfn_dashboard_props.rb

Overview

Properties for defining a CfnDashboard.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dashboard_definition:, dashboard_description:, dashboard_name:, project_id: nil, tags: nil) ⇒ CfnDashboardProps

Returns a new instance of CfnDashboardProps.

Parameters:

  • dashboard_definition (String) —

    The dashboard definition specified in a JSON literal.

  • dashboard_description (String) —

    A description for the dashboard.

  • dashboard_name (String) —

    A friendly name for the dashboard.

  • project_id (String, nil) (defaults to: nil) —

    The ID of the project in which to create the dashboard.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of key-value pairs that contain metadata for the dashboard.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 14

def initialize(dashboard_definition:, dashboard_description:, dashboard_name:, project_id: nil, tags: nil)
  @dashboard_definition = dashboard_definition
  Jsii::Type.check_type(@dashboard_definition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dashboardDefinition")
  @dashboard_description = dashboard_description
  Jsii::Type.check_type(@dashboard_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dashboardDescription")
  @dashboard_name = dashboard_name
  Jsii::Type.check_type(@dashboard_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dashboardName")
  @project_id = project_id
  Jsii::Type.check_type(@project_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "projectId") unless @project_id.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#dashboard_definition ⇒ String (readonly)

The dashboard definition specified in a JSON literal.

in the AWS IoT SiteWise User Guide

Returns:

  • (String)

See Also:



36
37
38
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 36

def dashboard_definition
  @dashboard_definition
end

#dashboard_description ⇒ String (readonly)

A description for the dashboard.

Returns:

  • (String)

See Also:



41
42
43
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 41

def dashboard_description
  @dashboard_description
end

#dashboard_name ⇒ String (readonly)

A friendly name for the dashboard.

Returns:

  • (String)

See Also:



46
47
48
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 46

def dashboard_name
  @dashboard_name
end

#project_id ⇒ String? (readonly)

The ID of the project in which to create the dashboard.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 51

def project_id
  @project_id
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of key-value pairs that contain metadata for the dashboard.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

Returns:

See Also:



58
59
60
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 58

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 60

def self.jsii_properties
  {
    :dashboard_definition => "dashboardDefinition",
    :dashboard_description => "dashboardDescription",
    :dashboard_name => "dashboardName",
    :project_id => "projectId",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
 
# File 'io_t_site_wise/cfn_dashboard_props.rb', line 70

def to_jsii
  result = {}
  result.merge!({
    "dashboardDefinition" => @dashboard_definition,
    "dashboardDescription" => @dashboard_description,
    "dashboardName" => @dashboard_name,
    "projectId" => @project_id,
    "tags" => @tags,
  })
  result.compact
end