Class: AWSCDK::Pipes::CfnPipe::PipeTargetTimestreamParametersProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pipes/cfn_pipe.rb

Overview

The parameters for using a Timestream for LiveAnalytics table as a target.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dimension_mappings:, time_value:, version_value:, epoch_time_unit: nil, multi_measure_mappings: nil, single_measure_mappings: nil, time_field_type: nil, timestamp_format: nil) ⇒ PipeTargetTimestreamParametersProperty

Returns a new instance of PipeTargetTimestreamParametersProperty.

Parameters:



3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
 
# File 'pipes/cfn_pipe.rb', line 3899

def initialize(dimension_mappings:, time_value:, version_value:, epoch_time_unit: nil, multi_measure_mappings: nil, single_measure_mappings: nil, time_field_type: nil, timestamp_format: nil)
  @dimension_mappings = dimension_mappings
  Jsii::Type.check_type(@dimension_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlwZXMuQ2ZuUGlwZS5EaW1lbnNpb25NYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "dimensionMappings")
  @time_value = time_value
  Jsii::Type.check_type(@time_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeValue")
  @version_value = version_value
  Jsii::Type.check_type(@version_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionValue")
  @epoch_time_unit = epoch_time_unit
  Jsii::Type.check_type(@epoch_time_unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "epochTimeUnit") unless @epoch_time_unit.nil?
  @multi_measure_mappings = multi_measure_mappings
  Jsii::Type.check_type(@multi_measure_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlwZXMuQ2ZuUGlwZS5NdWx0aU1lYXN1cmVNYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "multiMeasureMappings") unless @multi_measure_mappings.nil?
  @single_measure_mappings = single_measure_mappings
  Jsii::Type.check_type(@single_measure_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlwZXMuQ2ZuUGlwZS5TaW5nbGVNZWFzdXJlTWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "singleMeasureMappings") unless @single_measure_mappings.nil?
  @time_field_type = time_field_type
  Jsii::Type.check_type(@time_field_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeFieldType") unless @time_field_type.nil?
  @timestamp_format = timestamp_format
  Jsii::Type.check_type(@timestamp_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timestampFormat") unless @timestamp_format.nil?
end

Instance Attribute Details

#dimension_mappings ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Pipes::CfnPipe::DimensionMappingProperty> (readonly)

Map source data to dimensions in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

Returns:

See Also:



3924
3925
3926
 
# File 'pipes/cfn_pipe.rb', line 3924

def dimension_mappings
  @dimension_mappings
end

#epoch_time_unit ⇒ String? (readonly)

The granularity of the time units used. Default is MILLISECONDS .

Required if TimeFieldType is specified as EPOCH .

Returns:

  • (String, nil)

See Also:



3951
3952
3953
 
# File 'pipes/cfn_pipe.rb', line 3951

def epoch_time_unit
  @epoch_time_unit
end

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

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

Returns:

See Also:



3956
3957
3958
 
# File 'pipes/cfn_pipe.rb', line 3956

def multi_measure_mappings
  @multi_measure_mappings
end

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

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

Returns:

See Also:



3961
3962
3963
 
# File 'pipes/cfn_pipe.rb', line 3961

def single_measure_mappings
  @single_measure_mappings
end

#time_field_type ⇒ String? (readonly)

The type of time value used.

The default is EPOCH .

Returns:

  • (String, nil)

See Also:



3968
3969
3970
 
# File 'pipes/cfn_pipe.rb', line 3968

def time_field_type
  @time_field_type
end

#time_value ⇒ String (readonly)

Dynamic path to the source data field that represents the time value for your data.

Returns:

  • (String)

See Also:



3929
3930
3931
 
# File 'pipes/cfn_pipe.rb', line 3929

def time_value
  @time_value
end

#timestamp_format ⇒ String? (readonly)

How to format the timestamps. For example, yyyy-MM-dd'T'HH:mm:ss'Z' .

Required if TimeFieldType is specified as TIMESTAMP_FORMAT .

Returns:

  • (String, nil)

See Also:



3975
3976
3977
 
# File 'pipes/cfn_pipe.rb', line 3975

def timestamp_format
  @timestamp_format
end

#version_value ⇒ String (readonly)

64 bit version value or source data field that represents the version value for your data.

Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.

Default value is 1.

Timestream for LiveAnalytics does not support updating partial measure values in a record.

Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, Version will still be updated. Default value is 1 .

Version must be 1 or greater, or you will receive a ValidationException error.

Returns:

  • (String)

See Also:



3944
3945
3946
 
# File 'pipes/cfn_pipe.rb', line 3944

def version_value
  @version_value
end

Class Method Details

.jsii_properties ⇒ Object 



3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
 
# File 'pipes/cfn_pipe.rb', line 3977

def self.jsii_properties
  {
    :dimension_mappings => "dimensionMappings",
    :time_value => "timeValue",
    :version_value => "versionValue",
    :epoch_time_unit => "epochTimeUnit",
    :multi_measure_mappings => "multiMeasureMappings",
    :single_measure_mappings => "singleMeasureMappings",
    :time_field_type => "timeFieldType",
    :timestamp_format => "timestampFormat",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
 
# File 'pipes/cfn_pipe.rb', line 3990

def to_jsii
  result = {}
  result.merge!({
    "dimensionMappings" => @dimension_mappings,
    "timeValue" => @time_value,
    "versionValue" => @version_value,
    "epochTimeUnit" => @epoch_time_unit,
    "multiMeasureMappings" => @multi_measure_mappings,
    "singleMeasureMappings" => @single_measure_mappings,
    "timeFieldType" => @time_field_type,
    "timestampFormat" => @timestamp_format,
  })
  result.compact
end