CfnDatasetProps

class aws_cdk.aws_databrew.CfnDatasetProps(*, format=None, format_options=None, input, name, path_options=None, tags=None)

Bases: object

Properties for defining a AWS::DataBrew::Dataset.

Parameters
Link

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

Example:

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

cfn_dataset_props = databrew.CfnDatasetProps(
    input=databrew.CfnDataset.InputProperty(
        database_input_definition=databrew.CfnDataset.DatabaseInputDefinitionProperty(
            glue_connection_name="glueConnectionName",

            # the properties below are optional
            database_table_name="databaseTableName",
            query_string="queryString",
            temp_directory=databrew.CfnDataset.S3LocationProperty(
                bucket="bucket",

                # the properties below are optional
                key="key"
            )
        ),
        data_catalog_input_definition=databrew.CfnDataset.DataCatalogInputDefinitionProperty(
            catalog_id="catalogId",
            database_name="databaseName",
            table_name="tableName",
            temp_directory=databrew.CfnDataset.S3LocationProperty(
                bucket="bucket",

                # the properties below are optional
                key="key"
            )
        ),
        metadata=databrew.CfnDataset.MetadataProperty(
            source_arn="sourceArn"
        ),
        s3_input_definition=databrew.CfnDataset.S3LocationProperty(
            bucket="bucket",

            # the properties below are optional
            key="key"
        )
    ),
    name="name",

    # the properties below are optional
    format="format",
    format_options=databrew.CfnDataset.FormatOptionsProperty(
        csv=databrew.CfnDataset.CsvOptionsProperty(
            delimiter="delimiter",
            header_row=False
        ),
        excel=databrew.CfnDataset.ExcelOptionsProperty(
            header_row=False,
            sheet_indexes=[123],
            sheet_names=["sheetNames"]
        ),
        json=databrew.CfnDataset.JsonOptionsProperty(
            multi_line=False
        )
    ),
    path_options=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"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

format

AWS::DataBrew::Dataset.Format.

Link

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

Return type

Optional[str]

format_options

AWS::DataBrew::Dataset.FormatOptions.

Link

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

Return type

Union[IResolvable, FormatOptionsProperty, None]

input

AWS::DataBrew::Dataset.Input.

Link

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

Return type

Union[InputProperty, IResolvable]

name

AWS::DataBrew::Dataset.Name.

Link

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

Return type

str

path_options

AWS::DataBrew::Dataset.PathOptions.

Link

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

Return type

Union[IResolvable, PathOptionsProperty, None]

tags

AWS::DataBrew::Dataset.Tags.

Link

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

Return type

Optional[List[CfnTag]]