Class: AWSCDK::DataBrew::CfnJob::OutputProperty

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

Overview

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(location:, compression_format: nil, format: nil, format_options: nil, max_output_files: nil, overwrite: nil, partition_columns: nil) ⇒ OutputProperty

Returns a new instance of OutputProperty.

Parameters:

  • location (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::S3LocationProperty) —

    The location in Amazon S3 where the job writes its output.

  • compression_format (String, nil) (defaults to: nil) —

    The compression algorithm used to compress the output text of the job.

  • format (String, nil) (defaults to: nil) —

    The data format of the output of the job.

  • format_options (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::OutputFormatOptionsProperty, nil) (defaults to: nil) —

    Represents options that define how DataBrew formats job output files.

  • max_output_files (Numeric, nil) (defaults to: nil) —

    The maximum number of files to be generated by the job and written to the output folder.

  • overwrite (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that, if true, means that any data in the location specified for output is overwritten with new output.

  • partition_columns (Array<String>, nil) (defaults to: nil) —

    The names of one or more partition columns for the output of the job.



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'data_brew/cfn_job.rb', line 1311

def initialize(location:, compression_format: nil, format: nil, format_options: nil, max_output_files: nil, overwrite: nil, partition_columns: nil)
  @location = location.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::S3LocationProperty.new(**location.transform_keys(&:to_sym)) : location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "location")
  @compression_format = compression_format
  Jsii::Type.check_type(@compression_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "compressionFormat") unless @compression_format.nil?
  @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::CfnJob::OutputFormatOptionsProperty.new(**format_options.transform_keys(&:to_sym)) : format_options
  Jsii::Type.check_type(@format_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuT3V0cHV0Rm9ybWF0T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "formatOptions") unless @format_options.nil?
  @max_output_files = max_output_files
  Jsii::Type.check_type(@max_output_files, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxOutputFiles") unless @max_output_files.nil?
  @overwrite = overwrite
  Jsii::Type.check_type(@overwrite, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "overwrite") unless @overwrite.nil?
  @partition_columns = partition_columns
  Jsii::Type.check_type(@partition_columns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "partitionColumns") unless @partition_columns.nil?
end

Instance Attribute Details

#compression_format ⇒ String? (readonly)

The compression algorithm used to compress the output text of the job.

Returns:

  • (String, nil)

See Also:



1337
1338
1339
 
# File 'data_brew/cfn_job.rb', line 1337

def compression_format
  @compression_format
end

#format ⇒ String? (readonly)

The data format of the output of the job.

Returns:

  • (String, nil)

See Also:



1342
1343
1344
 
# File 'data_brew/cfn_job.rb', line 1342

def format
  @format
end

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

Represents options that define how DataBrew formats job output files.

Returns:

See Also:



1347
1348
1349
 
# File 'data_brew/cfn_job.rb', line 1347

def format_options
  @format_options
end

#location ⇒ AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::S3LocationProperty (readonly)

The location in Amazon S3 where the job writes its output.

Returns:

See Also:



1332
1333
1334
 
# File 'data_brew/cfn_job.rb', line 1332

def location
  @location
end

#max_output_files ⇒ Numeric? (readonly)

The maximum number of files to be generated by the job and written to the output folder.

Returns:

  • (Numeric, nil)

See Also:



1352
1353
1354
 
# File 'data_brew/cfn_job.rb', line 1352

def max_output_files
  @max_output_files
end

#overwrite ⇒ Boolean, ... (readonly)

A value that, if true, means that any data in the location specified for output is overwritten with new output.

Returns:

See Also:



1357
1358
1359
 
# File 'data_brew/cfn_job.rb', line 1357

def overwrite
  @overwrite
end

#partition_columns ⇒ Array<String>? (readonly)

The names of one or more partition columns for the output of the job.

Returns:

  • (Array<String>, nil)

See Also:



1362
1363
1364
 
# File 'data_brew/cfn_job.rb', line 1362

def partition_columns
  @partition_columns
end

Class Method Details

.jsii_properties ⇒ Object 



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'data_brew/cfn_job.rb', line 1364

def self.jsii_properties
  {
    :location => "location",
    :compression_format => "compressionFormat",
    :format => "format",
    :format_options => "formatOptions",
    :max_output_files => "maxOutputFiles",
    :overwrite => "overwrite",
    :partition_columns => "partitionColumns",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'data_brew/cfn_job.rb', line 1376

def to_jsii
  result = {}
  result.merge!({
    "location" => @location,
    "compressionFormat" => @compression_format,
    "format" => @format,
    "formatOptions" => @format_options,
    "maxOutputFiles" => @max_output_files,
    "overwrite" => @overwrite,
    "partitionColumns" => @partition_columns,
  })
  result.compact
end