Class: AWSCDK::DataBrew::CfnDatasetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
data_brew/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(input:, name:, format: nil, format_options: nil, path_options: nil, source: nil, tags: nil) ⇒ CfnDatasetProps

Returns a new instance of CfnDatasetProps.

Parameters:



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

def initialize(input:, name:, format: nil, format_options: nil, path_options: nil, source: nil, tags: nil)
  @input = input.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnDataset::InputProperty.new(**input.transform_keys(&:to_sym)) : input
  Jsii::Type.check_type(@input, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5EYXRhc2V0LklucHV0UHJvcGVydHkifV19fQ==")), "input")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format") unless @format.nil?
  @format_options = format_options.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnDataset::FormatOptionsProperty.new(**format_options.transform_keys(&:to_sym)) : format_options
  Jsii::Type.check_type(@format_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5EYXRhc2V0LkZvcm1hdE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "formatOptions") unless @format_options.nil?
  @path_options = path_options.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnDataset::PathOptionsProperty.new(**path_options.transform_keys(&:to_sym)) : path_options
  Jsii::Type.check_type(@path_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5EYXRhc2V0LlBhdGhPcHRpb25zUHJvcGVydHkifV19fQ==")), "pathOptions") unless @path_options.nil?
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "source") unless @source.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

#format ⇒ String? (readonly)

The file format of a dataset that is created from an Amazon S3 file or folder.

Returns:

  • (String, nil)

See Also:



47
48
49
 
# File 'data_brew/cfn_dataset_props.rb', line 47

def format
  @format
end

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

A set of options that define how DataBrew interprets the data in the dataset.

Returns:

See Also:



52
53
54
 
# File 'data_brew/cfn_dataset_props.rb', line 52

def format_options
  @format_options
end

#input ⇒ AWSCDK::IResolvable, AWSCDK::DataBrew::CfnDataset::InputProperty (readonly)

Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

Returns:

See Also:



37
38
39
 
# File 'data_brew/cfn_dataset_props.rb', line 37

def input
  @input
end

#name ⇒ String (readonly)

The unique name of the dataset.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'data_brew/cfn_dataset_props.rb', line 42

def name
  @name
end

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

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

Returns:

See Also:



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

def path_options
  @path_options
end

#source ⇒ String? (readonly)

The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'data_brew/cfn_dataset_props.rb', line 62

def source
  @source
end

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

Metadata tags that have been applied to the dataset.

Returns:

See Also:



67
68
69
 
# File 'data_brew/cfn_dataset_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'data_brew/cfn_dataset_props.rb', line 69

def self.jsii_properties
  {
    :input => "input",
    :name => "name",
    :format => "format",
    :format_options => "formatOptions",
    :path_options => "pathOptions",
    :source => "source",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'data_brew/cfn_dataset_props.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "input" => @input,
    "name" => @name,
    "format" => @format,
    "formatOptions" => @format_options,
    "pathOptions" => @path_options,
    "source" => @source,
    "tags" => @tags,
  })
  result.compact
end