Interface CfnDataset.IDatasetParameterProperty
Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDatasetParameterProperty
Syntax (vb)
Public Interface IDatasetParameterProperty
Remarks
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.AWS.DataBrew;
var datasetParameterProperty = new DatasetParameterProperty {
Name = "name",
Type = "type",
// the properties below are optional
CreateColumn = false,
DatetimeOptions = new DatetimeOptionsProperty {
Format = "format",
// the properties below are optional
LocaleCode = "localeCode",
TimezoneOffset = "timezoneOffset"
},
Filter = new FilterExpressionProperty {
Expression = "expression",
ValuesMap = new [] { new FilterValueProperty {
Value = "value",
ValueReference = "valueReference"
} }
}
};
Synopsis
Properties
CreateColumn | Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset. |
DatetimeOptions | Additional parameter options such as a format and a timezone. |
Filter | The optional filter expression structure to apply additional matching criteria to the parameter. |
Name | The name of the parameter that is used in the dataset's Amazon S3 path. |
Type | The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'. |
Properties
CreateColumn
Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.
virtual object CreateColumn { get; }
Property Value
System.Object
Remarks
DatetimeOptions
Additional parameter options such as a format and a timezone.
virtual object DatetimeOptions { get; }
Property Value
System.Object
Remarks
Filter
The optional filter expression structure to apply additional matching criteria to the parameter.
virtual object Filter { get; }
Property Value
System.Object
Remarks
Name
The name of the parameter that is used in the dataset's Amazon S3 path.
string Name { get; }
Property Value
System.String
Remarks
Type
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.
string Type { get; }
Property Value
System.String