Class: AWSCDK::DataBrew::CfnJob::DataCatalogOutputProperty

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

Overview

Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(database_name:, table_name:, catalog_id: nil, database_options: nil, overwrite: nil, s3_options: nil) ⇒ DataCatalogOutputProperty

Returns a new instance of DataCatalogOutputProperty.

Parameters:

  • database_name (String) —

    The name of a database in the Data Catalog.

  • table_name (String) —

    The name of a table in the Data Catalog.

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

    The unique identifier of the AWS account that holds the Data Catalog that stores the data.

  • database_options (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::DatabaseTableOutputOptionsProperty, nil) (defaults to: nil) —

    Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

  • 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.

  • s3_options (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::S3TableOutputOptionsProperty, nil) (defaults to: nil) —

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



920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'data_brew/cfn_job.rb', line 920

def initialize(database_name:, table_name:, catalog_id: nil, database_options: nil, overwrite: nil, s3_options: nil)
  @database_name = database_name
  Jsii::Type.check_type(@database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName")
  @table_name = table_name
  Jsii::Type.check_type(@table_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tableName")
  @catalog_id = catalog_id
  Jsii::Type.check_type(@catalog_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "catalogId") unless @catalog_id.nil?
  @database_options = database_options.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::DatabaseTableOutputOptionsProperty.new(**database_options.transform_keys(&:to_sym)) : database_options
  Jsii::Type.check_type(@database_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuRGF0YWJhc2VUYWJsZU91dHB1dE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "databaseOptions") unless @database_options.nil?
  @overwrite = overwrite
  Jsii::Type.check_type(@overwrite, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "overwrite") unless @overwrite.nil?
  @s3_options = s3_options.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::S3TableOutputOptionsProperty.new(**s3_options.transform_keys(&:to_sym)) : s3_options
  Jsii::Type.check_type(@s3_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuUzNUYWJsZU91dHB1dE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "s3Options") unless @s3_options.nil?
end

Instance Attribute Details

#catalog_id ⇒ String? (readonly)

The unique identifier of the AWS account that holds the Data Catalog that stores the data.

Returns:

  • (String, nil)

See Also:



949
950
951
 
# File 'data_brew/cfn_job.rb', line 949

def catalog_id
  @catalog_id
end

#database_name ⇒ String (readonly)

The name of a database in the Data Catalog.

Returns:

  • (String)

See Also:



939
940
941
 
# File 'data_brew/cfn_job.rb', line 939

def database_name
  @database_name
end

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

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

Returns:

See Also:



954
955
956
 
# File 'data_brew/cfn_job.rb', line 954

def database_options
  @database_options
end

#overwrite ⇒ Boolean, ... (readonly)

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

Not supported with DatabaseOptions.

Returns:

See Also:



961
962
963
 
# File 'data_brew/cfn_job.rb', line 961

def overwrite
  @overwrite
end

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

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

Returns:

See Also:



966
967
968
 
# File 'data_brew/cfn_job.rb', line 966

def s3_options
  @s3_options
end

#table_name ⇒ String (readonly)

The name of a table in the Data Catalog.

Returns:

  • (String)

See Also:



944
945
946
 
# File 'data_brew/cfn_job.rb', line 944

def table_name
  @table_name
end

Class Method Details

.jsii_properties ⇒ Object 



968
969
970
971
972
973
974
975
976
977
 
# File 'data_brew/cfn_job.rb', line 968

def self.jsii_properties
  {
    :database_name => "databaseName",
    :table_name => "tableName",
    :catalog_id => "catalogId",
    :database_options => "databaseOptions",
    :overwrite => "overwrite",
    :s3_options => "s3Options",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'data_brew/cfn_job.rb', line 979

def to_jsii
  result = {}
  result.merge!({
    "databaseName" => @database_name,
    "tableName" => @table_name,
    "catalogId" => @catalog_id,
    "databaseOptions" => @database_options,
    "overwrite" => @overwrite,
    "s3Options" => @s3_options,
  })
  result.compact
end