Skip to content
v2.277.0

PathParameterProperty Struct ​

Represents a single entry in the path parameters of a dataset.

Each PathParameter consists of a name and a parameter definition.

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 pathParameterProperty: databrew.CfnDataset.PathParameterProperty = {
  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_parameter_property = 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.*;

PathParameterProperty pathParameterProperty = 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();
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 pathParameterProperty = 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"

pathParameterProperty := &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 ​

datasetParameterIResolvable | CfnDataset.DatasetParameterPropertydataset_parametertyping.Union[IResolvable, DatasetParameterProperty]datasetParameterIResolvableDatasetParameterIResolvableDatasetParameterinterface{}required#
The path parameter definition.
pathParameterNamestringpath_parameter_namestrpathParameterNameStringPathParameterNamestringPathParameterName*stringrequired#
The name of the path parameter.