class CsvHeaders

Language	Type name
.NET	`Amazon.CDK.AWS.StepFunctions.CsvHeaders`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#CsvHeaders`
Java	`software.amazon.awscdk.services.stepfunctions.CsvHeaders`
Python	`aws_cdk.aws_stepfunctions.CsvHeaders`
TypeScript (source)	`aws-cdk-lib` » `aws_stepfunctions` » `CsvHeaders`

Configuration for CSV header options for a CSV Item Reader.

Example

// 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

Name	Type	Description
headerLocation	`CsvHeaderLocation`	Location of headers in CSV file.
headers?	`string[]`	List of headers if `headerLocation` is `GIVEN`.

headerLocation

Type: CsvHeaderLocation

Location of headers in CSV file.

headers?

Type: string[] (optional)

List of headers if headerLocation is GIVEN.

Methods

Name	Description
static use(headers)	Configures S3CsvItemReader to use the headers provided in the `headers` parameter.
static useFirstRow()	Configures S3CsvItemReader to read headers from the first row of the CSV file.

static use(headers)

public static use(headers: string[]): CsvHeaders

Parameters

headers string[] — - List of headers.

Returns

CsvHeaders

Configures S3CsvItemReader to use the headers provided in the headers parameter.

static useFirstRow()

public static useFirstRow(): CsvHeaders