Class: AWSCDK::IoTAnalytics::CfnDatastoreProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_analytics/cfn_datastore_props.rb

Overview

Properties for defining a CfnDatastore.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(datastore_name: nil, datastore_partitions: nil, datastore_storage: nil, file_format_configuration: nil, retention_period: nil, tags: nil) ⇒ CfnDatastoreProps

Returns a new instance of CfnDatastoreProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 15

def initialize(datastore_name: nil, datastore_partitions: nil, datastore_storage: nil, file_format_configuration: nil, retention_period: nil, tags: nil)
  @datastore_name = datastore_name
  Jsii::Type.check_type(@datastore_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "datastoreName") unless @datastore_name.nil?
  @datastore_partitions = datastore_partitions.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDatastore::DatastorePartitionsProperty.new(**datastore_partitions.transform_keys(&:to_sym)) : datastore_partitions
  Jsii::Type.check_type(@datastore_partitions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXN0b3JlLkRhdGFzdG9yZVBhcnRpdGlvbnNQcm9wZXJ0eSJ9XX19")), "datastorePartitions") unless @datastore_partitions.nil?
  @datastore_storage = datastore_storage.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDatastore::DatastoreStorageProperty.new(**datastore_storage.transform_keys(&:to_sym)) : datastore_storage
  Jsii::Type.check_type(@datastore_storage, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXN0b3JlLkRhdGFzdG9yZVN0b3JhZ2VQcm9wZXJ0eSJ9XX19")), "datastoreStorage") unless @datastore_storage.nil?
  @file_format_configuration = file_format_configuration.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDatastore::FileFormatConfigurationProperty.new(**file_format_configuration.transform_keys(&:to_sym)) : file_format_configuration
  Jsii::Type.check_type(@file_format_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXN0b3JlLkZpbGVGb3JtYXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "fileFormatConfiguration") unless @file_format_configuration.nil?
  @retention_period = retention_period.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnDatastore::RetentionPeriodProperty.new(**retention_period.transform_keys(&:to_sym)) : retention_period
  Jsii::Type.check_type(@retention_period, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuRGF0YXN0b3JlLlJldGVudGlvblBlcmlvZFByb3BlcnR5In1dfX0=")), "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?
end

Instance Attribute Details

#datastore_name ⇒ String? (readonly)

The name of the data store.

Returns:

  • (String, nil)

See Also:



34
35
36
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 34

def datastore_name
  @datastore_name
end

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

Information about the partition dimensions in a data store.

Returns:

See Also:



39
40
41
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 39

def datastore_partitions
  @datastore_partitions
end

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

Where data store data is stored.

Returns:

See Also:



44
45
46
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 44

def datastore_storage
  @datastore_storage
end

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

Contains the configuration information of file formats. ITA data stores support JSON and Parquet .

The default file format is JSON. You can specify only one format.

You can't change the file format after you create the data store.

Returns:

See Also:



53
54
55
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 53

def file_format_configuration
  @file_format_configuration
end

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

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

When customer_managed_s3 storage is selected, this parameter is ignored.

Returns:

See Also:



60
61
62
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 60

def retention_period
  @retention_period
end

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

Metadata which can be used to manage the data store.

For more information, see Tag .

Returns:

See Also:



67
68
69
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 69

def self.jsii_properties
  {
    :datastore_name => "datastoreName",
    :datastore_partitions => "datastorePartitions",
    :datastore_storage => "datastoreStorage",
    :file_format_configuration => "fileFormatConfiguration",
    :retention_period => "retentionPeriod",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'io_t_analytics/cfn_datastore_props.rb', line 80

def to_jsii
  result = {}
  result.merge!({
    "datastoreName" => @datastore_name,
    "datastorePartitions" => @datastore_partitions,
    "datastoreStorage" => @datastore_storage,
    "fileFormatConfiguration" => @file_format_configuration,
    "retentionPeriod" => @retention_period,
    "tags" => @tags,
  })
  result.compact
end