CfnDatasetPropsMixin

class aws_cdk.mixins_preview.aws_databrew.mixins.CfnDatasetPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a new DataBrew dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html

CloudformationResource:

AWS::DataBrew::Dataset

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

cfn_dataset_props_mixin = databrew_mixins.CfnDatasetPropsMixin(databrew_mixins.CfnDatasetMixinProps(
    format="format",
    format_options=databrew_mixins.CfnDatasetPropsMixin.FormatOptionsProperty(
        csv=databrew_mixins.CfnDatasetPropsMixin.CsvOptionsProperty(
            delimiter="delimiter",
            header_row=False
        ),
        excel=databrew_mixins.CfnDatasetPropsMixin.ExcelOptionsProperty(
            header_row=False,
            sheet_indexes=[123],
            sheet_names=["sheetNames"]
        ),
        json=databrew_mixins.CfnDatasetPropsMixin.JsonOptionsProperty(
            multi_line=False
        )
    ),
    input=databrew_mixins.CfnDatasetPropsMixin.InputProperty(
        database_input_definition=databrew_mixins.CfnDatasetPropsMixin.DatabaseInputDefinitionProperty(
            database_table_name="databaseTableName",
            glue_connection_name="glueConnectionName",
            query_string="queryString",
            temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
                bucket="bucket",
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        data_catalog_input_definition=databrew_mixins.CfnDatasetPropsMixin.DataCatalogInputDefinitionProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            table_name="tableName",
            temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
                bucket="bucket",
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        metadata=databrew_mixins.CfnDatasetPropsMixin.MetadataProperty(
            source_arn="sourceArn"
        ),
        s3_input_definition=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    name="name",
    path_options=databrew_mixins.CfnDatasetPropsMixin.PathOptionsProperty(
        files_limit=databrew_mixins.CfnDatasetPropsMixin.FilesLimitProperty(
            max_files=123,
            order="order",
            ordered_by="orderedBy"
        ),
        last_modified_date_condition=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
            expression="expression",
            values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
                value="value",
                value_reference="valueReference"
            )]
        ),
        parameters=[databrew_mixins.CfnDatasetPropsMixin.PathParameterProperty(
            dataset_parameter=databrew_mixins.CfnDatasetPropsMixin.DatasetParameterProperty(
                create_column=False,
                datetime_options=databrew_mixins.CfnDatasetPropsMixin.DatetimeOptionsProperty(
                    format="format",
                    locale_code="localeCode",
                    timezone_offset="timezoneOffset"
                ),
                filter=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
                    expression="expression",
                    values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
                        value="value",
                        value_reference="valueReference"
                    )]
                ),
                name="name",
                type="type"
            ),
            path_parameter_name="pathParameterName"
        )]
    ),
    source="source",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DataBrew::Dataset.

Parameters:

  • props (Union[CfnDatasetMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['format', 'formatOptions', 'input', 'name', 'pathOptions', 'source', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

CsvOptionsProperty

class CfnDatasetPropsMixin.CsvOptionsProperty(*, delimiter=None, header_row=None)

Bases: object

Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.

Parameters:

  • delimiter (Optional[str]) – A single character that specifies the delimiter being used in the CSV file.

  • header_row (Union[bool, IResolvable, None]) – A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

csv_options_property = databrew_mixins.CfnDatasetPropsMixin.CsvOptionsProperty(
    delimiter="delimiter",
    header_row=False
)

Attributes

delimiter

A single character that specifies the delimiter being used in the CSV file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-delimiter

header_row

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

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

See:

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

DataCatalogInputDefinitionProperty

class CfnDatasetPropsMixin.DataCatalogInputDefinitionProperty(*, catalog_id=None, database_name=None, table_name=None, temp_directory=None)

Bases: object

Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.

Parameters:

  • catalog_id (Optional[str]) – The unique identifier of the AWS account that holds the Data Catalog that stores the data.

  • database_name (Optional[str]) – The name of a database in the Data Catalog.

  • table_name (Optional[str]) – The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.

  • temp_directory (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

data_catalog_input_definition_property = databrew_mixins.CfnDatasetPropsMixin.DataCatalogInputDefinitionProperty(
    catalog_id="catalogId",
    database_name="databaseName",
    table_name="tableName",
    temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    )
)

Attributes

catalog_id

The unique identifier of the AWS account that holds the Data Catalog that stores the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-catalogid

database_name

The name of a database in the Data Catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-databasename

table_name

The name of a database table in the Data Catalog.

This table corresponds to a DataBrew dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tablename

temp_directory

An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory

DatabaseInputDefinitionProperty

class CfnDatasetPropsMixin.DatabaseInputDefinitionProperty(*, database_table_name=None, glue_connection_name=None, query_string=None, temp_directory=None)

Bases: object

Connection information for dataset input files stored in a database.

Parameters:

  • database_table_name (Optional[str]) – The table within the target database.

  • glue_connection_name (Optional[str]) – The AWS Glue Connection that stores the connection information for the target database.

  • query_string (Optional[str]) – Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs.

  • temp_directory (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

database_input_definition_property = databrew_mixins.CfnDatasetPropsMixin.DatabaseInputDefinitionProperty(
    database_table_name="databaseTableName",
    glue_connection_name="glueConnectionName",
    query_string="queryString",
    temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    )
)

Attributes

database_table_name

The table within the target database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-databasetablename

glue_connection_name

The AWS Glue Connection that stores the connection information for the target database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname

query_string

Custom SQL to run against the provided AWS Glue connection.

This SQL will be used as the input for DataBrew projects and jobs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-querystring

temp_directory

An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-tempdirectory

DatasetParameterProperty

class CfnDatasetPropsMixin.DatasetParameterProperty(*, create_column=None, datetime_options=None, filter=None, name=None, type=None)

Bases: object

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

Parameters:

  • create_column (Union[bool, IResolvable, None]) – Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset.

  • datetime_options (Union[IResolvable, DatetimeOptionsProperty, Dict[str, Any], None]) – Additional parameter options such as a format and a timezone. Required for datetime parameters.

  • filter (Union[IResolvable, FilterExpressionProperty, Dict[str, Any], None]) – The optional filter expression structure to apply additional matching criteria to the parameter.

  • name (Optional[str]) – The name of the parameter that is used in the dataset’s Amazon S3 path.

  • type (Optional[str]) – The type of the dataset parameter, can be one of a ‘String’, ‘Number’ or ‘Datetime’.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

dataset_parameter_property = databrew_mixins.CfnDatasetPropsMixin.DatasetParameterProperty(
    create_column=False,
    datetime_options=databrew_mixins.CfnDatasetPropsMixin.DatetimeOptionsProperty(
        format="format",
        locale_code="localeCode",
        timezone_offset="timezoneOffset"
    ),
    filter=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
        expression="expression",
        values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
            value="value",
            value_reference="valueReference"
        )]
    ),
    name="name",
    type="type"
)

Attributes

create_column

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-createcolumn

datetime_options

Additional parameter options such as a format and a timezone.

Required for datetime parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-datetimeoptions

filter

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-filter

name

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-name

type

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-type

DatetimeOptionsProperty

class CfnDatasetPropsMixin.DatetimeOptionsProperty(*, format=None, locale_code=None, timezone_offset=None)

Bases: object

Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.

Parameters:

  • format (Optional[str]) – Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character should be escaped with single quotes. E.g. “MM.dd.yyyy-‘at’-HH:mm”.

  • locale_code (Optional[str]) – Optional value for a non-US locale code, needed for correct interpretation of some date formats.

  • timezone_offset (Optional[str]) – Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn’t be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

datetime_options_property = databrew_mixins.CfnDatasetPropsMixin.DatetimeOptionsProperty(
    format="format",
    locale_code="localeCode",
    timezone_offset="timezoneOffset"
)

Attributes

format

Required option, that defines the datetime format used for a date parameter in the Amazon S3 path.

Should use only supported datetime specifiers and separation characters, all litera a-z or A-Z character should be escaped with single quotes. E.g. “MM.dd.yyyy-‘at’-HH:mm”.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-format

locale_code

Optional value for a non-US locale code, needed for correct interpretation of some date formats.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-localecode

timezone_offset

Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path.

Shouldn’t be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-timezoneoffset

ExcelOptionsProperty

class CfnDatasetPropsMixin.ExcelOptionsProperty(*, header_row=None, sheet_indexes=None, sheet_names=None)

Bases: object

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

Parameters:

  • header_row (Union[bool, IResolvable, None]) – A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

  • sheet_indexes (Union[Sequence[Union[int, float]], IResolvable, None]) – One or more sheet numbers in the Excel file that will be included in the dataset.

  • sheet_names (Optional[Sequence[str]]) – One or more named sheets in the Excel file that will be included in the dataset.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

excel_options_property = databrew_mixins.CfnDatasetPropsMixin.ExcelOptionsProperty(
    header_row=False,
    sheet_indexes=[123],
    sheet_names=["sheetNames"]
)

Attributes

header_row

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

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

sheet_indexes

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

See:

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

sheet_names

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

See:

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

FilesLimitProperty

class CfnDatasetPropsMixin.FilesLimitProperty(*, max_files=None, order=None, ordered_by=None)

Bases: object

Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.

Parameters:

  • max_files (Union[int, float, None]) – The number of Amazon S3 files to select.

  • order (Optional[str]) – A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

  • ordered_by (Optional[str]) – A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it’s the only allowed value.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

files_limit_property = databrew_mixins.CfnDatasetPropsMixin.FilesLimitProperty(
    max_files=123,
    order="order",
    ordered_by="orderedBy"
)

Attributes

max_files

The number of Amazon S3 files to select.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-maxfiles

order

A criteria to use for Amazon S3 files sorting before their selection.

By default uses DESCENDING order, i.e. most recent files are selected first. Anotherpossible value is ASCENDING.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-order

ordered_by

A criteria to use for Amazon S3 files sorting before their selection.

By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it’s the only allowed value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-orderedby

FilterExpressionProperty

class CfnDatasetPropsMixin.FilterExpressionProperty(*, expression=None, values_map=None)

Bases: object

Represents a structure for defining parameter conditions.

Parameters:

  • expression (Optional[str]) – The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, “(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)”. Substitution variables should start with ‘:’ symbol.

  • values_map (Union[IResolvable, Sequence[Union[IResolvable, FilterValueProperty, Dict[str, Any]]], None]) – The map of substitution variable names to their values used in this filter expression.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

filter_expression_property = databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
    expression="expression",
    values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
        value="value",
        value_reference="valueReference"
    )]
)

Attributes

expression

The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions.

For example, “(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)”. Substitution variables should start with ‘:’ symbol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-expression

values_map

The map of substitution variable names to their values used in this filter expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-valuesmap

FilterValueProperty

class CfnDatasetPropsMixin.FilterValueProperty(*, value=None, value_reference=None)

Bases: object

Represents a single entry in the ValuesMap of a FilterExpression .

A FilterValue associates the name of a substitution variable in an expression to its value.

Parameters:

  • value (Optional[str]) – The value to be associated with the substitution variable.

  • value_reference (Optional[str]) – The substitution variable reference.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

filter_value_property = databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
    value="value",
    value_reference="valueReference"
)

Attributes

value

The value to be associated with the substitution variable.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-value

value_reference

The substitution variable reference.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-valuereference

FormatOptionsProperty

class CfnDatasetPropsMixin.FormatOptionsProperty(*, csv=None, excel=None, json=None)

Bases: object

Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

format_options_property = databrew_mixins.CfnDatasetPropsMixin.FormatOptionsProperty(
    csv=databrew_mixins.CfnDatasetPropsMixin.CsvOptionsProperty(
        delimiter="delimiter",
        header_row=False
    ),
    excel=databrew_mixins.CfnDatasetPropsMixin.ExcelOptionsProperty(
        header_row=False,
        sheet_indexes=[123],
        sheet_names=["sheetNames"]
    ),
    json=databrew_mixins.CfnDatasetPropsMixin.JsonOptionsProperty(
        multi_line=False
    )
)

Attributes

csv

Options that define how CSV input is to be interpreted by DataBrew.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-csv

excel

Options that define how Excel input is to be interpreted by DataBrew.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-excel

json

Options that define how JSON input is to be interpreted by DataBrew.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-json

InputProperty

class CfnDatasetPropsMixin.InputProperty(*, database_input_definition=None, data_catalog_input_definition=None, metadata=None, s3_input_definition=None)

Bases: object

Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

input_property = databrew_mixins.CfnDatasetPropsMixin.InputProperty(
    database_input_definition=databrew_mixins.CfnDatasetPropsMixin.DatabaseInputDefinitionProperty(
        database_table_name="databaseTableName",
        glue_connection_name="glueConnectionName",
        query_string="queryString",
        temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    data_catalog_input_definition=databrew_mixins.CfnDatasetPropsMixin.DataCatalogInputDefinitionProperty(
        catalog_id="catalogId",
        database_name="databaseName",
        table_name="tableName",
        temp_directory=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    metadata=databrew_mixins.CfnDatasetPropsMixin.MetadataProperty(
        source_arn="sourceArn"
    ),
    s3_input_definition=databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    )
)

Attributes

data_catalog_input_definition

The AWS Glue Data Catalog parameters for the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-datacataloginputdefinition

database_input_definition

Connection information for dataset input files stored in a database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-databaseinputdefinition

metadata

Contains additional resource information needed for specific datasets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-metadata

s3_input_definition

The Amazon S3 location where the data is stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-s3inputdefinition

JsonOptionsProperty

class CfnDatasetPropsMixin.JsonOptionsProperty(*, multi_line=None)

Bases: object

Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew .

Parameters:

multi_line (Union[bool, IResolvable, None]) – A value that specifies whether JSON input contains embedded new line characters.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

json_options_property = databrew_mixins.CfnDatasetPropsMixin.JsonOptionsProperty(
    multi_line=False
)

Attributes

multi_line

A value that specifies whether JSON input contains embedded new line characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html#cfn-databrew-dataset-jsonoptions-multiline

MetadataProperty

class CfnDatasetPropsMixin.MetadataProperty(*, source_arn=None)

Bases: object

Contains additional resource information needed for specific datasets.

Parameters:

source_arn (Optional[str]) – The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

metadata_property = databrew_mixins.CfnDatasetPropsMixin.MetadataProperty(
    source_arn="sourceArn"
)

Attributes

source_arn

The Amazon Resource Name (ARN) associated with the dataset.

Currently, DataBrew only supports ARNs from Amazon AppFlow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html#cfn-databrew-dataset-metadata-sourcearn

PathOptionsProperty

class CfnDatasetPropsMixin.PathOptionsProperty(*, files_limit=None, last_modified_date_condition=None, parameters=None)

Bases: object

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

Parameters:

  • files_limit (Union[IResolvable, FilesLimitProperty, Dict[str, Any], None]) – If provided, this structure imposes a limit on a number of files that should be selected.

  • last_modified_date_condition (Union[IResolvable, FilterExpressionProperty, Dict[str, Any], None]) – If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .

  • parameters (Union[IResolvable, Sequence[Union[IResolvable, PathParameterProperty, Dict[str, Any]]], None]) – A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

path_options_property = databrew_mixins.CfnDatasetPropsMixin.PathOptionsProperty(
    files_limit=databrew_mixins.CfnDatasetPropsMixin.FilesLimitProperty(
        max_files=123,
        order="order",
        ordered_by="orderedBy"
    ),
    last_modified_date_condition=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
        expression="expression",
        values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
            value="value",
            value_reference="valueReference"
        )]
    ),
    parameters=[databrew_mixins.CfnDatasetPropsMixin.PathParameterProperty(
        dataset_parameter=databrew_mixins.CfnDatasetPropsMixin.DatasetParameterProperty(
            create_column=False,
            datetime_options=databrew_mixins.CfnDatasetPropsMixin.DatetimeOptionsProperty(
                format="format",
                locale_code="localeCode",
                timezone_offset="timezoneOffset"
            ),
            filter=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
                expression="expression",
                values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
                    value="value",
                    value_reference="valueReference"
                )]
            ),
            name="name",
            type="type"
        ),
        path_parameter_name="pathParameterName"
    )]
)

Attributes

files_limit

If provided, this structure imposes a limit on a number of files that should be selected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-fileslimit

last_modified_date_condition

If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-lastmodifieddatecondition

parameters

A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-parameters

PathParameterProperty

class CfnDatasetPropsMixin.PathParameterProperty(*, dataset_parameter=None, path_parameter_name=None)

Bases: object

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

Each PathParameter consists of a name and a parameter definition.

Parameters:

  • dataset_parameter (Union[IResolvable, DatasetParameterProperty, Dict[str, Any], None]) – The path parameter definition.

  • path_parameter_name (Optional[str]) – The name of the path parameter.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

path_parameter_property = databrew_mixins.CfnDatasetPropsMixin.PathParameterProperty(
    dataset_parameter=databrew_mixins.CfnDatasetPropsMixin.DatasetParameterProperty(
        create_column=False,
        datetime_options=databrew_mixins.CfnDatasetPropsMixin.DatetimeOptionsProperty(
            format="format",
            locale_code="localeCode",
            timezone_offset="timezoneOffset"
        ),
        filter=databrew_mixins.CfnDatasetPropsMixin.FilterExpressionProperty(
            expression="expression",
            values_map=[databrew_mixins.CfnDatasetPropsMixin.FilterValueProperty(
                value="value",
                value_reference="valueReference"
            )]
        ),
        name="name",
        type="type"
    ),
    path_parameter_name="pathParameterName"
)

Attributes

dataset_parameter

The path parameter definition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-datasetparameter

path_parameter_name

The name of the path parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-pathparametername

S3LocationProperty

class CfnDatasetPropsMixin.S3LocationProperty(*, bucket=None, bucket_owner=None, key=None)

Bases: object

Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.

Parameters:

  • bucket (Optional[str]) – The Amazon S3 bucket name.

  • bucket_owner (Optional[str]) – The AWS account ID of the bucket owner.

  • key (Optional[str]) – The unique name of the object in the bucket.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_databrew import mixins as databrew_mixins

s3_location_property = databrew_mixins.CfnDatasetPropsMixin.S3LocationProperty(
    bucket="bucket",
    bucket_owner="bucketOwner",
    key="key"
)

Attributes

bucket

The Amazon S3 bucket name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucket

bucket_owner

The AWS account ID of the bucket owner.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucketowner

key

The unique name of the object in the bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-key