Class: Aws::Firehose::Types::CopyCommand

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

Note:

When making an API call, you may pass CopyCommand data as a hash:

{
  data_table_name: "DataTableName", # required
  data_table_columns: "DataTableColumns",
  copy_options: "CopyOptions",
}

Describes a `COPY` command for Amazon Redshift.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_optionsString

Optional parameters to use with the Amazon Redshift `COPY` command. For more information, see the “Optional Parameters” section of [Amazon Redshift COPY command]. Some possible examples that would apply to Kinesis Data Firehose are as follows:

`delimiter 't' lzop;` - fields are delimited with “\t” (TAB character) and compressed using lzop.

`delimiter '|'` - fields are delimited with “|” (this is the default delimiter).

`delimiter '|' escape` - the delimiter should be escaped.

`fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'` - fields are fixed width in the source, with each width specified after every column in the table.

`JSON 's3://mybucket/jsonpaths.txt'` - data is in JSON format, and the path specified is the format of the data.

For more examples, see [Amazon Redshift COPY command examples].

[1]: docs.aws.amazon.com/redshift/latest/dg/r_COPY.html [2]: docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html

Returns:

  • (String)

509
510
511
512
513
514
515
# File 'lib/aws-sdk-firehose/types.rb', line 509

class CopyCommand < Struct.new(
  :data_table_name,
  :data_table_columns,
  :copy_options)
  SENSITIVE = []
  include Aws::Structure
end

#data_table_columnsString

A comma-separated list of column names.

Returns:

  • (String)

509
510
511
512
513
514
515
# File 'lib/aws-sdk-firehose/types.rb', line 509

class CopyCommand < Struct.new(
  :data_table_name,
  :data_table_columns,
  :copy_options)
  SENSITIVE = []
  include Aws::Structure
end

#data_table_nameString

The name of the target table. The table must already exist in the database.

Returns:

  • (String)

509
510
511
512
513
514
515
# File 'lib/aws-sdk-firehose/types.rb', line 509

class CopyCommand < Struct.new(
  :data_table_name,
  :data_table_columns,
  :copy_options)
  SENSITIVE = []
  include Aws::Structure
end