CfnDatasetMixinProps

class aws_cdk.mixins_preview.aws_databrew.mixins.CfnDatasetMixinProps(*, format=None, format_options=None, input=None, name=None, path_options=None, source=None, tags=None)

Bases: object

Properties for CfnDatasetPropsMixin.

Parameters:
  • format (Optional[str]) – The file format of a dataset that is created from an Amazon S3 file or folder.

  • format_options (Union[IResolvable, FormatOptionsProperty, Dict[str, Any], None]) – A set of options that define how DataBrew interprets the data in the dataset.

  • input (Union[IResolvable, InputProperty, Dict[str, Any], None]) – Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

  • name (Optional[str]) – The unique name of the dataset.

  • path_options (Union[IResolvable, PathOptionsProperty, Dict[str, Any], None]) – A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

  • source (Optional[str]) – The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata tags that have been applied to the dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.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

cfn_dataset_mixin_props = 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"
    )]
)

Attributes

format

The file format of a dataset that is created from an Amazon S3 file or folder.

See:

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

format_options

A set of options that define how DataBrew interprets the data in the dataset.

See:

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

input

Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .

See:

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

name

The unique name of the dataset.

See:

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

path_options

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

See:

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

source

The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .

See:

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

tags

Metadata tags that have been applied to the dataset.

See:

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