AWS::DataBrew::Dataset DatasetParameter - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::DataBrew::Dataset DatasetParameter

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CreateColumn" : Boolean,
  "DatetimeOptions" : DatetimeOptions,
  "Filter" : FilterExpression,
  "Name" : String,
  "Type" : String
}

Properties

CreateColumn

Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.

Required: No

Type: Boolean

Update requires: No interruption

DatetimeOptions

Additional parameter options such as a format and a timezone. Required for datetime parameters.

Required: No

Type: DatetimeOptions

Update requires: No interruption

Filter

The optional filter expression structure to apply additional matching criteria to the parameter.

Required: No

Type: FilterExpression

Update requires: No interruption

Name

The name of the parameter that is used in the dataset's Amazon S3 path.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Type

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Required: Yes

Type: String

Allowed values: String | Number | Datetime

Update requires: No interruption