Class: AWSCDK::IoTSiteWise::CfnDatasetProps

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

Overview

Properties for defining a CfnDataset.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dataset_name:, dataset_source:, dataset_description: nil, tags: nil) ⇒ CfnDatasetProps

Returns a new instance of CfnDatasetProps.

Parameters:



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

def initialize(dataset_name:, dataset_source:, dataset_description: nil, tags: nil)
  @dataset_name = dataset_name
  Jsii::Type.check_type(@dataset_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetName")
  @dataset_source = dataset_source.is_a?(Hash) ? ::AWSCDK::IoTSiteWise::CfnDataset::DatasetSourceProperty.new(**dataset_source.transform_keys(&:to_sym)) : dataset_source
  Jsii::Type.check_type(@dataset_source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RzaXRld2lzZS5DZm5EYXRhc2V0LkRhdGFzZXRTb3VyY2VQcm9wZXJ0eSJ9XX19")), "datasetSource")
  @dataset_description = dataset_description
  Jsii::Type.check_type(@dataset_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetDescription") unless @dataset_description.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

#dataset_description ⇒ String? (readonly)

A description about the dataset, and its functionality.

Returns:

  • (String, nil)

See Also:



38
39
40
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 38

def dataset_description
  @dataset_description
end

#dataset_name ⇒ String (readonly)

The name of the dataset.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 28

def dataset_name
  @dataset_name
end

#dataset_source ⇒ AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnDataset::DatasetSourceProperty (readonly)

The data source for the dataset.

Returns:

See Also:



33
34
35
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 33

def dataset_source
  @dataset_source
end

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

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

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

Returns:

See Also:



45
46
47
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 47

def self.jsii_properties
  {
    :dataset_name => "datasetName",
    :dataset_source => "datasetSource",
    :dataset_description => "datasetDescription",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'io_t_site_wise/cfn_dataset_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "datasetName" => @dataset_name,
    "datasetSource" => @dataset_source,
    "datasetDescription" => @dataset_description,
    "tags" => @tags,
  })
  result.compact
end