Skip to content
v2.277.0

PathOptionsProperty Struct ​

Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.

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 pathOptionsProperty: databrew.CfnDataset.PathOptionsProperty = {
  filesLimit: {
    maxFiles: 123,

    // the properties below are optional
    order: 'order',
    orderedBy: 'orderedBy',
  },
  lastModifiedDateCondition: {
    expression: 'expression',
    valuesMap: [{
      value: 'value',
      valueReference: 'valueReference',
    }],
  },
  parameters: [{
    datasetParameter: {
      name: 'name',
      type: 'type',

      // the properties below are optional
      createColumn: false,
      datetimeOptions: {
        format: 'format',

        // the properties below are optional
        localeCode: 'localeCode',
        timezoneOffset: 'timezoneOffset',
      },
      filter: {
        expression: 'expression',
        valuesMap: [{
          value: 'value',
          valueReference: 'valueReference',
        }],
      },
    },
    pathParameterName: 'pathParameterName',
  }],
};
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

path_options_property = databrew.CfnDataset.PathOptionsProperty(
    files_limit=databrew.CfnDataset.FilesLimitProperty(
        max_files=123,

        # the properties below are optional
        order="order",
        ordered_by="orderedBy"
    ),
    last_modified_date_condition=databrew.CfnDataset.FilterExpressionProperty(
        expression="expression",
        values_map=[databrew.CfnDataset.FilterValueProperty(
            value="value",
            value_reference="valueReference"
        )]
    ),
    parameters=[databrew.CfnDataset.PathParameterProperty(
        dataset_parameter=databrew.CfnDataset.DatasetParameterProperty(
            name="name",
            type="type",

            # the properties below are optional
            create_column=False,
            datetime_options=databrew.CfnDataset.DatetimeOptionsProperty(
                format="format",

                # the properties below are optional
                locale_code="localeCode",
                timezone_offset="timezoneOffset"
            ),
            filter=databrew.CfnDataset.FilterExpressionProperty(
                expression="expression",
                values_map=[databrew.CfnDataset.FilterValueProperty(
                    value="value",
                    value_reference="valueReference"
                )]
            )
        ),
        path_parameter_name="pathParameterName"
    )]
)
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.*;

PathOptionsProperty pathOptionsProperty = PathOptionsProperty.builder()
        .filesLimit(FilesLimitProperty.builder()
                .maxFiles(123)

                // the properties below are optional
                .order("order")
                .orderedBy("orderedBy")
                .build())
        .lastModifiedDateCondition(FilterExpressionProperty.builder()
                .expression("expression")
                .valuesMap(List.of(FilterValueProperty.builder()
                        .value("value")
                        .valueReference("valueReference")
                        .build()))
                .build())
        .parameters(List.of(PathParameterProperty.builder()
                .datasetParameter(DatasetParameterProperty.builder()
                        .name("name")
                        .type("type")

                        // the properties below are optional
                        .createColumn(false)
                        .datetimeOptions(DatetimeOptionsProperty.builder()
                                .format("format")

                                // the properties below are optional
                                .localeCode("localeCode")
                                .timezoneOffset("timezoneOffset")
                                .build())
                        .filter(FilterExpressionProperty.builder()
                                .expression("expression")
                                .valuesMap(List.of(FilterValueProperty.builder()
                                        .value("value")
                                        .valueReference("valueReference")
                                        .build()))
                                .build())
                        .build())
                .pathParameterName("pathParameterName")
                .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 pathOptionsProperty = new PathOptionsProperty {
    FilesLimit = new FilesLimitProperty {
        MaxFiles = 123,

        // the properties below are optional
        Order = "order",
        OrderedBy = "orderedBy"
    },
    LastModifiedDateCondition = new FilterExpressionProperty {
        Expression = "expression",
        ValuesMap = new [] { new FilterValueProperty {
            Value = "value",
            ValueReference = "valueReference"
        } }
    },
    Parameters = new [] { new PathParameterProperty {
        DatasetParameter = 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"
                } }
            }
        },
        PathParameterName = "pathParameterName"
    } }
};
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"

pathOptionsProperty := &PathOptionsProperty{
	FilesLimit: &FilesLimitProperty{
		MaxFiles: jsii.Number(123),

		// the properties below are optional
		Order: jsii.String("order"),
		OrderedBy: jsii.String("orderedBy"),
	},
	LastModifiedDateCondition: &FilterExpressionProperty{
		Expression: jsii.String("expression"),
		ValuesMap: []interface{}{
			&FilterValueProperty{
				Value: jsii.String("value"),
				ValueReference: jsii.String("valueReference"),
			},
		},
	},
	Parameters: []interface{}{
		&PathParameterProperty{
			DatasetParameter: &DatasetParameterProperty{
				Name: jsii.String("name"),
				Type: jsii.String("type"),

				// the properties below are optional
				CreateColumn: jsii.Boolean(false),
				DatetimeOptions: &DatetimeOptionsProperty{
					Format: jsii.String("format"),

					// the properties below are optional
					LocaleCode: jsii.String("localeCode"),
					TimezoneOffset: jsii.String("timezoneOffset"),
				},
				Filter: &FilterExpressionProperty{
					Expression: jsii.String("expression"),
					ValuesMap: []interface{}{
						&FilterValueProperty{
							Value: jsii.String("value"),
							ValueReference: jsii.String("valueReference"),
						},
					},
				},
			},
			PathParameterName: jsii.String("pathParameterName"),
		},
	},
}

Properties ​

filesLimitoptionalIResolvable | CfnDataset.FilesLimitPropertyfiles_limitoptionaltyping.Union[IResolvable, FilesLimitProperty]filesLimitoptionalIResolvableFilesLimitoptionalIResolvableFilesLimitoptionalinterface{}#
If provided, this structure imposes a limit on a number of files that should be selected.
lastModifiedDateConditionoptionalIResolvable | CfnDataset.FilterExpressionPropertylast_modified_date_conditionoptionaltyping.Union[IResolvable, FilterExpressionProperty]lastModifiedDateConditionoptionalIResolvableLastModifiedDateConditionoptionalIResolvableLastModifiedDateConditionoptionalinterface{}#
If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .
parametersoptionalIResolvable | IResolvable | CfnDataset.PathParameterProperty[]parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PathParameterProperty]]]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#
A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.