Class: AWSCDK::DataBrew::CfnDataset::DatasetParameterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_brew/cfn_dataset.rb

Overview

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, create_column: nil, datetime_options: nil, filter: nil) ⇒ DatasetParameterProperty

Returns a new instance of DatasetParameterProperty.

Parameters:



762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'data_brew/cfn_dataset.rb', line 762

def initialize(name:, type:, create_column: nil, datetime_options: nil, filter: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @create_column = create_column
  Jsii::Type.check_type(@create_column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "createColumn") unless @create_column.nil?
  @datetime_options = datetime_options.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnDataset::DatetimeOptionsProperty.new(**datetime_options.transform_keys(&:to_sym)) : datetime_options
  Jsii::Type.check_type(@datetime_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5EYXRhc2V0LkRhdGV0aW1lT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "datetimeOptions") unless @datetime_options.nil?
  @filter = filter.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnDataset::FilterExpressionProperty.new(**filter.transform_keys(&:to_sym)) : filter
  Jsii::Type.check_type(@filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5EYXRhc2V0LkZpbHRlckV4cHJlc3Npb25Qcm9wZXJ0eSJ9XX19")), "filter") unless @filter.nil?
end

Instance Attribute Details

#create_column ⇒ Boolean, ... (readonly)

Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.

Returns:

See Also:



789
790
791
 
# File 'data_brew/cfn_dataset.rb', line 789

def create_column
  @create_column
end

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

Additional parameter options such as a format and a timezone.

Required for datetime parameters.

Returns:

See Also:



796
797
798
 
# File 'data_brew/cfn_dataset.rb', line 796

def datetime_options
  @datetime_options
end

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

The optional filter expression structure to apply additional matching criteria to the parameter.

Returns:

See Also:



801
802
803
 
# File 'data_brew/cfn_dataset.rb', line 801

def filter
  @filter
end

#name ⇒ String (readonly)

The name of the parameter that is used in the dataset's Amazon S3 path.

Returns:

  • (String)

See Also:



779
780
781
 
# File 'data_brew/cfn_dataset.rb', line 779

def name
  @name
end

#type ⇒ String (readonly)

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Returns:

  • (String)

See Also:



784
785
786
 
# File 'data_brew/cfn_dataset.rb', line 784

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



803
804
805
806
807
808
809
810
811
 
# File 'data_brew/cfn_dataset.rb', line 803

def self.jsii_properties
  {
    :name => "name",
    :type => "type",
    :create_column => "createColumn",
    :datetime_options => "datetimeOptions",
    :filter => "filter",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



813
814
815
816
817
818
819
820
821
822
823
 
# File 'data_brew/cfn_dataset.rb', line 813

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "type" => @type,
    "createColumn" => @create_column,
    "datetimeOptions" => @datetime_options,
    "filter" => @filter,
  })
  result.compact
end