CsvHeaders Class
Configuration for CSV header options for a CSV Item Reader.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const csvHeaders = stepfunctions.CsvHeaders.use(['headers']);
Properties
headerLocationCsvHeaderLocationheader_locationCsvHeaderLocationheaderLocationCsvHeaderLocationHeaderLocationCsvHeaderLocationHeaderLocationCsvHeaderLocationrequired#Location of headers in CSV file.
headersmay be undefinedstring[]headersmay be undefinedtyping.List[str]headersmay be undefinedList<String>Headersmay be undefinedstring[]Headersmay be undefined*[]*string#List of headers if `headerLocation` is `GIVEN`.
Methods
use(headers: string[]): CsvHeaders // chainable@staticmethod def use(headers: typing.List[str]) -> CsvHeaderspublic static CsvHeaders use(List<String> headers)public static CsvHeaders Use(string[] headers)func Use(Headers *[]*string) CsvHeadersstatic#Configures S3CsvItemReader to use the headers provided in the `headers` parameter.
1 parameter · returns
Parameters
headersheadersheadersheadersHeaders— - List of headers.
Returns: - CsvHeaders
useFirstRow(): CsvHeaders // chainable@staticmethod def use_first_row() -> CsvHeaderspublic static CsvHeaders useFirstRow()public static CsvHeaders UseFirstRow()func UseFirstRow() CsvHeadersstatic#Configures S3CsvItemReader to read headers from the first row of the CSV file.
returns
Returns: - CsvHeaders