Class: Aws::Appflow::Types::S3OutputFormatConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

Note:

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

{
  file_type: "CSV", # accepts CSV, JSON, PARQUET
  prefix_config: {
    prefix_type: "FILENAME", # accepts FILENAME, PATH, PATH_AND_FILENAME
    prefix_format: "YEAR", # accepts YEAR, MONTH, DAY, HOUR, MINUTE
  },
  aggregation_config: {
    aggregation_type: "None", # accepts None, SingleFile
  },
  preserve_source_data_typing: false,
}

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_config ⇒ Types::AggregationConfig

The aggregation settings that you can use to customize the output format of your flow data.

Returns:



5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5249

class S3OutputFormatConfig < Struct.new(
  :file_type,
  :prefix_config,
  :aggregation_config,
  :preserve_source_data_typing)
  SENSITIVE = []
  include Aws::Structure
end

#file_type ⇒ String

Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

Returns:

  • (String) 


5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5249

class S3OutputFormatConfig < Struct.new(
  :file_type,
  :prefix_config,
  :aggregation_config,
  :preserve_source_data_typing)
  SENSITIVE = []
  include Aws::Structure
end

#prefix_config ⇒ Types::PrefixConfig

Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

Returns:



5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5249

class S3OutputFormatConfig < Struct.new(
  :file_type,
  :prefix_config,
  :aggregation_config,
  :preserve_source_data_typing)
  SENSITIVE = []
  include Aws::Structure
end

#preserve_source_data_typing ⇒ Boolean

If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

  • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.

  • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.

Returns:

  • (Boolean) 


5249
5250
5251
5252
5253
5254
5255
5256
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 5249

class S3OutputFormatConfig < Struct.new(
  :file_type,
  :prefix_config,
  :aggregation_config,
  :preserve_source_data_typing)
  SENSITIVE = []
  include Aws::Structure
end