Show / Hide Table of Contents

Class CfnDatasetPropsMixin.ExcelOptionsProperty

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

Inheritance
object
CfnDatasetPropsMixin.ExcelOptionsProperty
Implements
CfnDatasetPropsMixin.IExcelOptionsProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.DataBrew.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnDatasetPropsMixin.ExcelOptionsProperty : CfnDatasetPropsMixin.IExcelOptionsProperty
Syntax (vb)
Public Class CfnDatasetPropsMixin.ExcelOptionsProperty Implements CfnDatasetPropsMixin.IExcelOptionsProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.DataBrew.Mixins;

             var excelOptionsProperty = new ExcelOptionsProperty {
                 HeaderRow = false,
                 SheetIndexes = new [] { 123 },
                 SheetNames = new [] { "sheetNames" }
             };

Synopsis

Constructors

ExcelOptionsProperty()

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

Properties

HeaderRow

A variable that specifies whether the first row in the file is parsed as the header.

SheetIndexes

One or more sheet numbers in the Excel file that will be included in the dataset.

SheetNames

One or more named sheets in the Excel file that will be included in the dataset.

Constructors

ExcelOptionsProperty()

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

public ExcelOptionsProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.DataBrew.Mixins;

             var excelOptionsProperty = new ExcelOptionsProperty {
                 HeaderRow = false,
                 SheetIndexes = new [] { 123 },
                 SheetNames = new [] { "sheetNames" }
             };

Properties

HeaderRow

A variable that specifies whether the first row in the file is parsed as the header.

public object? HeaderRow { get; set; }
Property Value

object

Remarks

If this value is false, column names are auto-generated.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-headerrow

Type union: either bool or IResolvable

SheetIndexes

One or more sheet numbers in the Excel file that will be included in the dataset.

public object? SheetIndexes { get; set; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetindexes

Type union: either (double)[] or IResolvable

SheetNames

One or more named sheets in the Excel file that will be included in the dataset.

public string[]? SheetNames { get; set; }
Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetnames

Implements

CfnDatasetPropsMixin.IExcelOptionsProperty
Back to top Generated by DocFX