Class: AWSCDK::KinesisFirehose::CfnDeliveryStream::CopyCommandProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/cfn_delivery_stream.rb

Overview

The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_table_name:, copy_options: nil, data_table_columns: nil) ⇒ CopyCommandProperty

Returns a new instance of CopyCommandProperty.

Parameters:

  • data_table_name (String) —

    The name of the target table.

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

    Parameters to use with the Amazon Redshift COPY command.

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

    A comma-separated list of column names.



1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1441

def initialize(data_table_name:, copy_options: nil, data_table_columns: nil)
  @data_table_name = data_table_name
  Jsii::Type.check_type(@data_table_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataTableName")
  @copy_options = copy_options
  Jsii::Type.check_type(@copy_options, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "copyOptions") unless @copy_options.nil?
  @data_table_columns = data_table_columns
  Jsii::Type.check_type(@data_table_columns, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataTableColumns") unless @data_table_columns.nil?
end

Instance Attribute Details

#copy_options ⇒ String? (readonly)

Parameters to use with the Amazon Redshift COPY command.

For examples, see the CopyOptions content for the CopyCommand data type in the Amazon Kinesis Data Firehose API Reference .

Returns:

  • (String, nil)

See Also:



1463
1464
1465
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1463

def copy_options
  @copy_options
end

#data_table_columns ⇒ String? (readonly)

A comma-separated list of column names.

Returns:

  • (String, nil)

See Also:



1468
1469
1470
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1468

def data_table_columns
  @data_table_columns
end

#data_table_name ⇒ String (readonly)

The name of the target table.

The table must already exist in the database.

Returns:

  • (String)

See Also:



1456
1457
1458
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1456

def data_table_name
  @data_table_name
end

Class Method Details

.jsii_properties ⇒ Object 



1470
1471
1472
1473
1474
1475
1476
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1470

def self.jsii_properties
  {
    :data_table_name => "dataTableName",
    :copy_options => "copyOptions",
    :data_table_columns => "dataTableColumns",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1478
1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'kinesis_firehose/cfn_delivery_stream.rb', line 1478

def to_jsii
  result = {}
  result.merge!({
    "dataTableName" => @data_table_name,
    "copyOptions" => @copy_options,
    "dataTableColumns" => @data_table_columns,
  })
  result.compact
end