Skip to content
v2.277.0

FormatOptionsProperty Struct ​

Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_databrew as databrew } from 'aws-cdk-lib';
const formatOptionsProperty: databrew.CfnDataset.FormatOptionsProperty = {
  csv: {
    delimiter: 'delimiter',
    headerRow: false,
  },
  excel: {
    headerRow: false,
    sheetIndexes: [123],
    sheetNames: ['sheetNames'],
  },
  json: {
    multiLine: false,
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_databrew as databrew

format_options_property = databrew.CfnDataset.FormatOptionsProperty(
    csv=databrew.CfnDataset.CsvOptionsProperty(
        delimiter="delimiter",
        header_row=False
    ),
    excel=databrew.CfnDataset.ExcelOptionsProperty(
        header_row=False,
        sheet_indexes=[123],
        sheet_names=["sheetNames"]
    ),
    json=databrew.CfnDataset.JsonOptionsProperty(
        multi_line=False
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.databrew.*;

FormatOptionsProperty formatOptionsProperty = FormatOptionsProperty.builder()
        .csv(CsvOptionsProperty.builder()
                .delimiter("delimiter")
                .headerRow(false)
                .build())
        .excel(ExcelOptionsProperty.builder()
                .headerRow(false)
                .sheetIndexes(List.of(123))
                .sheetNames(List.of("sheetNames"))
                .build())
        .json(JsonOptionsProperty.builder()
                .multiLine(false)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataBrew;

var formatOptionsProperty = new FormatOptionsProperty {
    Csv = new CsvOptionsProperty {
        Delimiter = "delimiter",
        HeaderRow = false
    },
    Excel = new ExcelOptionsProperty {
        HeaderRow = false,
        SheetIndexes = new [] { 123 },
        SheetNames = new [] { "sheetNames" }
    },
    Json = new JsonOptionsProperty {
        MultiLine = false
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

formatOptionsProperty := &FormatOptionsProperty{
	Csv: &CsvOptionsProperty{
		Delimiter: jsii.String("delimiter"),
		HeaderRow: jsii.Boolean(false),
	},
	Excel: &ExcelOptionsProperty{
		HeaderRow: jsii.Boolean(false),
		SheetIndexes: []interface{}{
			jsii.Number(123),
		},
		SheetNames: []*string{
			jsii.String("sheetNames"),
		},
	},
	Json: &JsonOptionsProperty{
		MultiLine: jsii.Boolean(false),
	},
}

Properties ​

csvoptionalIResolvable | CfnDataset.CsvOptionsPropertycsvoptionaltyping.Union[IResolvable, CsvOptionsProperty]csvoptionalIResolvableCsvoptionalIResolvableCsvoptionalinterface{}#
Options that define how CSV input is to be interpreted by DataBrew.
exceloptionalIResolvable | CfnDataset.ExcelOptionsPropertyexceloptionaltyping.Union[IResolvable, ExcelOptionsProperty]exceloptionalIResolvableExceloptionalIResolvableExceloptionalinterface{}#
Options that define how Excel input is to be interpreted by DataBrew.
jsonoptionalIResolvable | CfnDataset.JsonOptionsPropertyjsonoptionaltyping.Union[IResolvable, JsonOptionsProperty]jsonoptionalIResolvableJsonoptionalIResolvableJsonoptionalinterface{}#
Options that define how JSON input is to be interpreted by DataBrew.