Class: AWSCDK::IoTAnalytics::CfnDatasetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_analytics/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(actions:, content_delivery_rules: nil, dataset_name: nil, late_data_rules: nil, retention_period: nil, tags: nil, triggers: nil, versioning_configuration: nil) ⇒ CfnDatasetProps

Returns a new instance of CfnDatasetProps.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 17

def initialize(actions:, content_delivery_rules: nil, dataset_name: nil, late_data_rules: nil, retention_period: nil, tags: nil, triggers: nil, versioning_configuration: nil)
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90YW5hbHl0aWNzLkNmbkRhdGFzZXQuQWN0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actions")
  @content_delivery_rules = content_delivery_rules
  Jsii::Type.check_type(@content_delivery_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90YW5hbHl0aWNzLkNmbkRhdGFzZXQuRGF0YXNldENvbnRlbnREZWxpdmVyeVJ1bGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "contentDeliveryRules") unless @content_delivery_rules.nil?
  @dataset_name = dataset_name
  Jsii::Type.check_type(@dataset_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datasetName") unless @dataset_name.nil?
  @late_data_rules = late_data_rules
  Jsii::Type.check_type(@late_data_rules, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90YW5hbHl0aWNzLkNmbkRhdGFzZXQuTGF0ZURhdGFSdWxlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "lateDataRules") unless @late_data_rules.nil?
  @retention_period = retention_period.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDataset::RetentionPeriodProperty.new(**retention_period.transform_keys(&:to_sym)) : retention_period
  Jsii::Type.check_type(@retention_period, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXNldC5SZXRlbnRpb25QZXJpb2RQcm9wZXJ0eSJ9XX19")), "retentionPeriod") unless @retention_period.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?
  @triggers = triggers
  Jsii::Type.check_type(@triggers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90YW5hbHl0aWNzLkNmbkRhdGFzZXQuVHJpZ2dlclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "triggers") unless @triggers.nil?
  @versioning_configuration = versioning_configuration.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDataset::VersioningConfigurationProperty.new(**versioning_configuration.transform_keys(&:to_sym)) : versioning_configuration
  Jsii::Type.check_type(@versioning_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXNldC5WZXJzaW9uaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "versioningConfiguration") unless @versioning_configuration.nil?
end

Instance Attribute Details

#actions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::IoTAnalytics::CfnDataset::ActionProperty> (readonly)

The DatasetAction objects that automatically create the dataset contents.

Returns:

See Also:



40
41
42
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 40

def actions
  @actions
end

#content_delivery_rules ⇒ AWSCDK::IResolvable, ... (readonly)

When dataset contents are created they are delivered to destinations specified here.

Returns:

See Also:



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

def content_delivery_rules
  @content_delivery_rules
end

#dataset_name ⇒ String? (readonly)

The name of the dataset.

Returns:

  • (String, nil)

See Also:



50
51
52
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 50

def dataset_name
  @dataset_name
end

#late_data_rules ⇒ AWSCDK::IResolvable, ... (readonly)

A list of data rules that send notifications to CloudWatch, when data arrives late.

To specify late_data_rules , the dataset must use a DeltaTimer filter.

Returns:

See Also:



57
58
59
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 57

def late_data_rules
  @late_data_rules
end

#retention_period ⇒ AWSCDK::IResolvable, ... (readonly)

Optional.

How long, in days, message data is kept for the dataset.

Returns:

See Also:



64
65
66
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 64

def retention_period
  @retention_period
end

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

Metadata which can be used to manage the data set.

For more information, see Tag .

Returns:

See Also:



71
72
73
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 71

def tags
  @tags
end

#triggers ⇒ AWSCDK::IResolvable, ... (readonly)

The DatasetTrigger objects that specify when the dataset is automatically updated.

Returns:

See Also:



76
77
78
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 76

def triggers
  @triggers
end

#versioning_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Optional.

How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retention_period parameter. For more information, see Keeping Multiple Versions of ITA datasets in the ITA User Guide .

Returns:

See Also:



83
84
85
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 83

def versioning_configuration
  @versioning_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 85

def self.jsii_properties
  {
    :actions => "actions",
    :content_delivery_rules => "contentDeliveryRules",
    :dataset_name => "datasetName",
    :late_data_rules => "lateDataRules",
    :retention_period => "retentionPeriod",
    :tags => "tags",
    :triggers => "triggers",
    :versioning_configuration => "versioningConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'io_t_analytics/cfn_dataset_props.rb', line 98

def to_jsii
  result = {}
  result.merge!({
    "actions" => @actions,
    "contentDeliveryRules" => @content_delivery_rules,
    "datasetName" => @dataset_name,
    "lateDataRules" => @late_data_rules,
    "retentionPeriod" => @retention_period,
    "tags" => @tags,
    "triggers" => @triggers,
    "versioningConfiguration" => @versioning_configuration,
  })
  result.compact
end