CfnJobPropsMixin

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

Bases: Mixin

Specifies a new DataBrew job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html
CloudformationResource:: AWS::DataBrew::Job
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_job_props_mixin = databrew_mixins.CfnJobPropsMixin(databrew_mixins.CfnJobMixinProps(
    database_outputs=[databrew_mixins.CfnJobPropsMixin.DatabaseOutputProperty(
        database_options=databrew_mixins.CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(
            table_name="tableName",
            temp_directory=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
                bucket="bucket",
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        database_output_mode="databaseOutputMode",
        glue_connection_name="glueConnectionName"
    )],
    data_catalog_outputs=[databrew_mixins.CfnJobPropsMixin.DataCatalogOutputProperty(
        catalog_id="catalogId",
        database_name="databaseName",
        database_options=databrew_mixins.CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(
            table_name="tableName",
            temp_directory=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
                bucket="bucket",
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        overwrite=False,
        s3_options=databrew_mixins.CfnJobPropsMixin.S3TableOutputOptionsProperty(
            location=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
                bucket="bucket",
                bucket_owner="bucketOwner",
                key="key"
            )
        ),
        table_name="tableName"
    )],
    dataset_name="datasetName",
    encryption_key_arn="encryptionKeyArn",
    encryption_mode="encryptionMode",
    job_sample=databrew_mixins.CfnJobPropsMixin.JobSampleProperty(
        mode="mode",
        size=123
    ),
    log_subscription="logSubscription",
    max_capacity=123,
    max_retries=123,
    name="name",
    output_location=databrew_mixins.CfnJobPropsMixin.OutputLocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    ),
    outputs=[databrew_mixins.CfnJobPropsMixin.OutputProperty(
        compression_format="compressionFormat",
        format="format",
        format_options=databrew_mixins.CfnJobPropsMixin.OutputFormatOptionsProperty(
            csv=databrew_mixins.CfnJobPropsMixin.CsvOutputOptionsProperty(
                delimiter="delimiter"
            )
        ),
        location=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        ),
        max_output_files=123,
        overwrite=False,
        partition_columns=["partitionColumns"]
    )],
    profile_configuration=databrew_mixins.CfnJobPropsMixin.ProfileConfigurationProperty(
        column_statistics_configurations=[databrew_mixins.CfnJobPropsMixin.ColumnStatisticsConfigurationProperty(
            selectors=[databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
                name="name",
                regex="regex"
            )],
            statistics=databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
                included_statistics=["includedStatistics"],
                overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
                    parameters={
                        "parameters_key": "parameters"
                    },
                    statistic="statistic"
                )]
            )
        )],
        dataset_statistics_configuration=databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
            included_statistics=["includedStatistics"],
            overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
                parameters={
                    "parameters_key": "parameters"
                },
                statistic="statistic"
            )]
        ),
        entity_detector_configuration=databrew_mixins.CfnJobPropsMixin.EntityDetectorConfigurationProperty(
            allowed_statistics=databrew_mixins.CfnJobPropsMixin.AllowedStatisticsProperty(
                statistics=["statistics"]
            ),
            entity_types=["entityTypes"]
        ),
        profile_columns=[databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
            name="name",
            regex="regex"
        )]
    ),
    project_name="projectName",
    recipe=databrew_mixins.CfnJobPropsMixin.RecipeProperty(
        name="name",
        version="version"
    ),
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    timeout=123,
    type="type",
    validation_configurations=[databrew_mixins.CfnJobPropsMixin.ValidationConfigurationProperty(
        ruleset_arn="rulesetArn",
        validation_mode="validationMode"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnJobMixinProps, 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 = ['databaseOutputs', 'dataCatalogOutputs', 'datasetName', 'encryptionKeyArn', 'encryptionMode', 'jobSample', 'logSubscription', 'maxCapacity', 'maxRetries', 'name', 'outputLocation', 'outputs', 'profileConfiguration', 'projectName', 'recipe', 'roleArn', 'tags', 'timeout', 'type', 'validationConfigurations']

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

AllowedStatisticsProperty

class CfnJobPropsMixin.AllowedStatisticsProperty(*, statistics=None)

Bases: object

Configuration of statistics that are allowed to be run on columns that contain detected entities.

When undefined, no statistics will be computed on columns that contain detected entities.

Parameters:: statistics (Optional[Sequence[str]]) – One or more column statistics to allow for columns that contain detected entities.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.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

allowed_statistics_property = databrew_mixins.CfnJobPropsMixin.AllowedStatisticsProperty(
    statistics=["statistics"]
)

Attributes

statistics

One or more column statistics to allow for columns that contain detected entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html#cfn-databrew-job-allowedstatistics-statistics

ColumnSelectorProperty

class CfnJobPropsMixin.ColumnSelectorProperty(*, name=None, regex=None)

Bases: object

Selector of a column from a dataset for profile job configuration.

One selector includes either a column name or a regular expression.

Parameters:

name (Optional[str]) – The name of a column from a dataset.
regex (Optional[str]) – A regular expression for selecting a column from a dataset.

See:

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

column_selector_property = databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
    name="name",
    regex="regex"
)

Attributes

name

The name of a column from a dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-name

regex

A regular expression for selecting a column from a dataset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-regex

ColumnStatisticsConfigurationProperty

class CfnJobPropsMixin.ColumnStatisticsConfigurationProperty(*, selectors=None, statistics=None)

Bases: object

Configuration for column evaluations for a profile job.

ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns.

Parameters:

selectors (Union[IResolvable, Sequence[Union[IResolvable, ColumnSelectorProperty, Dict[str, Any]]], None]) – List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.
statistics (Union[IResolvable, StatisticsConfigurationProperty, Dict[str, Any], None]) – Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations.

See:

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

column_statistics_configuration_property = databrew_mixins.CfnJobPropsMixin.ColumnStatisticsConfigurationProperty(
    selectors=[databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
        name="name",
        regex="regex"
    )],
    statistics=databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
        included_statistics=["includedStatistics"],
        overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
            parameters={
                "parameters_key": "parameters"
            },
            statistic="statistic"
        )]
    )
)

Attributes

selectors

List of column selectors.

Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-selectors

statistics

Configuration for evaluations.

Statistics can be used to select evaluations and override parameters of evaluations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-statistics

CsvOutputOptionsProperty

class CfnJobPropsMixin.CsvOutputOptionsProperty(*, delimiter=None)

Bases: object

Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.

Parameters:: delimiter (Optional[str]) – A single character that specifies the delimiter used to create CSV job output.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.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_output_options_property = databrew_mixins.CfnJobPropsMixin.CsvOutputOptionsProperty(
    delimiter="delimiter"
)

Attributes

delimiter

A single character that specifies the delimiter used to create CSV job output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.html#cfn-databrew-job-csvoutputoptions-delimiter

DataCatalogOutputProperty

class CfnJobPropsMixin.DataCatalogOutputProperty(*, catalog_id=None, database_name=None, database_options=None, overwrite=None, s3_options=None, table_name=None)

Bases: object

Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.

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.
database_options (Union[IResolvable, DatabaseTableOutputOptionsProperty, Dict[str, Any], None]) – Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
overwrite (Union[bool, IResolvable, None]) – A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.
s3_options (Union[IResolvable, S3TableOutputOptionsProperty, Dict[str, Any], None]) – Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
table_name (Optional[str]) – The name of a table in the Data Catalog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.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_output_property = databrew_mixins.CfnJobPropsMixin.DataCatalogOutputProperty(
    catalog_id="catalogId",
    database_name="databaseName",
    database_options=databrew_mixins.CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(
        table_name="tableName",
        temp_directory=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    overwrite=False,
    s3_options=databrew_mixins.CfnJobPropsMixin.S3TableOutputOptionsProperty(
        location=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    table_name="tableName"
)

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-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-catalogid

database_name

The name of a database in the Data Catalog.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databasename

database_options

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databaseoptions

overwrite

A value that, if true, means that any data in the location specified for output is overwritten with new output.

Not supported with DatabaseOptions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-overwrite

s3_options

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-s3options

table_name

The name of a table in the Data Catalog.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-tablename

DatabaseOutputProperty

class CfnJobPropsMixin.DatabaseOutputProperty(*, database_options=None, database_output_mode=None, glue_connection_name=None)

Bases: object

Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.

Parameters:

database_options (Union[IResolvable, DatabaseTableOutputOptionsProperty, Dict[str, Any], None]) – Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
database_output_mode (Optional[str]) – The output mode to write into the database. Currently supported option: NEW_TABLE.
glue_connection_name (Optional[str]) – 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-job-databaseoutput.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_output_property = databrew_mixins.CfnJobPropsMixin.DatabaseOutputProperty(
    database_options=databrew_mixins.CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(
        table_name="tableName",
        temp_directory=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
            bucket="bucket",
            bucket_owner="bucketOwner",
            key="key"
        )
    ),
    database_output_mode="databaseOutputMode",
    glue_connection_name="glueConnectionName"
)

Attributes

database_options

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html#cfn-databrew-job-databaseoutput-databaseoptions

database_output_mode

The output mode to write into the database.

Currently supported option: NEW_TABLE.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html#cfn-databrew-job-databaseoutput-databaseoutputmode

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-job-databaseoutput.html#cfn-databrew-job-databaseoutput-glueconnectionname

DatabaseTableOutputOptionsProperty

class CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(*, table_name=None, temp_directory=None)

Bases: object

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

Parameters:

table_name (Optional[str]) – A prefix for the name of a table DataBrew will create in the database.
temp_directory (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.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_table_output_options_property = databrew_mixins.CfnJobPropsMixin.DatabaseTableOutputOptionsProperty(
    table_name="tableName",
    temp_directory=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    )
)

Attributes

table_name

A prefix for the name of a table DataBrew will create in the database.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html#cfn-databrew-job-databasetableoutputoptions-tablename

temp_directory

Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html#cfn-databrew-job-databasetableoutputoptions-tempdirectory

EntityDetectorConfigurationProperty

class CfnJobPropsMixin.EntityDetectorConfigurationProperty(*, allowed_statistics=None, entity_types=None)

Bases: object

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

Parameters:

allowed_statistics (Union[IResolvable, AllowedStatisticsProperty, Dict[str, Any], None]) – Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
entity_types (Optional[Sequence[str]]) – Entity types to detect. Can be any of the following:. - USA_SSN - EMAIL - USA_ITIN - USA_PASSPORT_NUMBER - PHONE_NUMBER - USA_DRIVING_LICENSE - BANK_ACCOUNT - CREDIT_CARD - IP_ADDRESS - MAC_ADDRESS - USA_DEA_NUMBER - USA_HCPCS_CODE - USA_NATIONAL_PROVIDER_IDENTIFIER - USA_NATIONAL_DRUG_CODE - USA_HEALTH_INSURANCE_CLAIM_NUMBER - USA_MEDICARE_BENEFICIARY_IDENTIFIER - USA_CPT_CODE - PERSON_NAME - DATE The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

See:

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

entity_detector_configuration_property = databrew_mixins.CfnJobPropsMixin.EntityDetectorConfigurationProperty(
    allowed_statistics=databrew_mixins.CfnJobPropsMixin.AllowedStatisticsProperty(
        statistics=["statistics"]
    ),
    entity_types=["entityTypes"]
)

Attributes

allowed_statistics

Configuration of statistics that are allowed to be run on columns that contain detected entities.

When undefined, no statistics will be computed on columns that contain detected entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-allowedstatistics

entity_types

.

USA_SSN
EMAIL
USA_ITIN
USA_PASSPORT_NUMBER
PHONE_NUMBER
USA_DRIVING_LICENSE
BANK_ACCOUNT
CREDIT_CARD
IP_ADDRESS
MAC_ADDRESS
USA_DEA_NUMBER
USA_HCPCS_CODE
USA_NATIONAL_PROVIDER_IDENTIFIER
USA_NATIONAL_DRUG_CODE
USA_HEALTH_INSURANCE_CLAIM_NUMBER
USA_MEDICARE_BENEFICIARY_IDENTIFIER
USA_CPT_CODE
PERSON_NAME
DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-entitytypes
Type:: Entity types to detect. Can be any of the following

JobSampleProperty

class CfnJobPropsMixin.JobSampleProperty(*, mode=None, size=None)

Bases: object

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

If a JobSample value isn’t provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

Parameters:

mode (Optional[str]) – A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following: - FULL_DATASET - The profile job is run on the entire dataset. - CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.
size (Union[int, float, None]) – The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE. Long.MAX_VALUE = 9223372036854775807

See:

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

job_sample_property = databrew_mixins.CfnJobPropsMixin.JobSampleProperty(
    mode="mode",
    size=123
)

Attributes

mode

A value that determines whether the profile job is run on the entire dataset or a specified number of rows.

This value must be one of the following:

FULL_DATASET - The profile job is run on the entire dataset.
CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-jobsample.html#cfn-databrew-job-jobsample-mode

size

The Size parameter is only required when the mode is CUSTOM_ROWS.

The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-jobsample.html#cfn-databrew-job-jobsample-size

OutputFormatOptionsProperty

class CfnJobPropsMixin.OutputFormatOptionsProperty(*, csv=None)

Bases: object

Represents a set of options that define the structure of comma-separated (CSV) job output.

Parameters:: csv (Union[IResolvable, CsvOutputOptionsProperty, Dict[str, Any], None]) – Represents a set of options that define the structure of comma-separated value (CSV) job output.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputformatoptions.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

output_format_options_property = databrew_mixins.CfnJobPropsMixin.OutputFormatOptionsProperty(
    csv=databrew_mixins.CfnJobPropsMixin.CsvOutputOptionsProperty(
        delimiter="delimiter"
    )
)

Attributes

csv

Represents a set of options that define the structure of comma-separated value (CSV) job output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputformatoptions.html#cfn-databrew-job-outputformatoptions-csv

OutputLocationProperty

class CfnJobPropsMixin.OutputLocationProperty(*, bucket=None, bucket_owner=None, key=None)

Bases: object

The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output.

Parameters:

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

See:

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

output_location_property = databrew_mixins.CfnJobPropsMixin.OutputLocationProperty(
    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-job-outputlocation.html#cfn-databrew-job-outputlocation-bucket

bucket_owner

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

Type:: see

key

The unique name of the object in the bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html#cfn-databrew-job-outputlocation-key

OutputProperty

class CfnJobPropsMixin.OutputProperty(*, compression_format=None, format=None, format_options=None, location=None, max_output_files=None, overwrite=None, partition_columns=None)

Bases: object

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.

Parameters:

compression_format (Optional[str]) – The compression algorithm used to compress the output text of the job.
format (Optional[str]) – The data format of the output of the job.
format_options (Union[IResolvable, OutputFormatOptionsProperty, Dict[str, Any], None]) – Represents options that define how DataBrew formats job output files.
location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The location in Amazon S3 where the job writes its output.
max_output_files (Union[int, float, None]) – The maximum number of files to be generated by the job and written to the output folder.
overwrite (Union[bool, IResolvable, None]) – A value that, if true, means that any data in the location specified for output is overwritten with new output.
partition_columns (Optional[Sequence[str]]) – The names of one or more partition columns for the output of the job.

See:

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

output_property = databrew_mixins.CfnJobPropsMixin.OutputProperty(
    compression_format="compressionFormat",
    format="format",
    format_options=databrew_mixins.CfnJobPropsMixin.OutputFormatOptionsProperty(
        csv=databrew_mixins.CfnJobPropsMixin.CsvOutputOptionsProperty(
            delimiter="delimiter"
        )
    ),
    location=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    ),
    max_output_files=123,
    overwrite=False,
    partition_columns=["partitionColumns"]
)

Attributes

compression_format

The compression algorithm used to compress the output text of the job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-compressionformat

format

The data format of the output of the job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-format

format_options

Represents options that define how DataBrew formats job output files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-formatoptions

location

The location in Amazon S3 where the job writes its output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-location

max_output_files

The maximum number of files to be generated by the job and written to the output folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-maxoutputfiles

overwrite

A value that, if true, means that any data in the location specified for output is overwritten with new output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-overwrite

partition_columns

The names of one or more partition columns for the output of the job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-partitioncolumns

ProfileConfigurationProperty

class CfnJobPropsMixin.ProfileConfigurationProperty(*, column_statistics_configurations=None, dataset_statistics_configuration=None, entity_detector_configuration=None, profile_columns=None)

Bases: object

Configuration for profile jobs.

Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

Parameters:

column_statistics_configurations (Union[IResolvable, Sequence[Union[IResolvable, ColumnStatisticsConfigurationProperty, Dict[str, Any]]], None]) – List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.
dataset_statistics_configuration (Union[IResolvable, StatisticsConfigurationProperty, Dict[str, Any], None]) – Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.
entity_detector_configuration (Union[IResolvable, EntityDetectorConfigurationProperty, Dict[str, Any], None]) – Configuration of entity detection for a profile job. When undefined, entity detection is disabled.
profile_columns (Union[IResolvable, Sequence[Union[IResolvable, ColumnSelectorProperty, Dict[str, Any]]], None]) – List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

See:

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

profile_configuration_property = databrew_mixins.CfnJobPropsMixin.ProfileConfigurationProperty(
    column_statistics_configurations=[databrew_mixins.CfnJobPropsMixin.ColumnStatisticsConfigurationProperty(
        selectors=[databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
            name="name",
            regex="regex"
        )],
        statistics=databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
            included_statistics=["includedStatistics"],
            overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
                parameters={
                    "parameters_key": "parameters"
                },
                statistic="statistic"
            )]
        )
    )],
    dataset_statistics_configuration=databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
        included_statistics=["includedStatistics"],
        overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
            parameters={
                "parameters_key": "parameters"
            },
            statistic="statistic"
        )]
    ),
    entity_detector_configuration=databrew_mixins.CfnJobPropsMixin.EntityDetectorConfigurationProperty(
        allowed_statistics=databrew_mixins.CfnJobPropsMixin.AllowedStatisticsProperty(
            statistics=["statistics"]
        ),
        entity_types=["entityTypes"]
    ),
    profile_columns=[databrew_mixins.CfnJobPropsMixin.ColumnSelectorProperty(
        name="name",
        regex="regex"
    )]
)

Attributes

column_statistics_configurations

List of configurations for column evaluations.

ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-columnstatisticsconfigurations

dataset_statistics_configuration

Configuration for inter-column evaluations.

Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-datasetstatisticsconfiguration

entity_detector_configuration

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-entitydetectorconfiguration

profile_columns

List of column selectors.

ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html#cfn-databrew-job-profileconfiguration-profilecolumns

RecipeProperty

class CfnJobPropsMixin.RecipeProperty(*, name=None, version=None)

Bases: object

Represents one or more actions to be performed on a DataBrew dataset.

Parameters:

name (Optional[str]) – The unique name for the recipe.
version (Optional[str]) – The identifier for the version for the recipe.

See:

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

recipe_property = databrew_mixins.CfnJobPropsMixin.RecipeProperty(
    name="name",
    version="version"
)

Attributes

name

The unique name for the recipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html#cfn-databrew-job-recipe-name

version

The identifier for the version for the recipe.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html#cfn-databrew-job-recipe-version

S3LocationProperty

class CfnJobPropsMixin.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-job-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.CfnJobPropsMixin.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-job-s3location.html#cfn-databrew-job-s3location-bucket

bucket_owner

The AWS account ID of the bucket owner.

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

key

The unique name of the object in the bucket.

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

S3TableOutputOptionsProperty

class CfnJobPropsMixin.S3TableOutputOptionsProperty(*, location=None)

Bases: object

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

Parameters:: location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3tableoutputoptions.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_table_output_options_property = databrew_mixins.CfnJobPropsMixin.S3TableOutputOptionsProperty(
    location=databrew_mixins.CfnJobPropsMixin.S3LocationProperty(
        bucket="bucket",
        bucket_owner="bucketOwner",
        key="key"
    )
)

Attributes

location

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3tableoutputoptions.html#cfn-databrew-job-s3tableoutputoptions-location

StatisticOverrideProperty

class CfnJobPropsMixin.StatisticOverrideProperty(*, parameters=None, statistic=None)

Bases: object

Override of a particular evaluation for a profile job.

Parameters:

parameters (Union[Mapping[str, str], IResolvable, None]) – A map that includes overrides of an evaluation’s parameters.
statistic (Optional[str]) – The name of an evaluation.

See:

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

statistic_override_property = databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
    parameters={
        "parameters_key": "parameters"
    },
    statistic="statistic"
)

Attributes

parameters

A map that includes overrides of an evaluation’s parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html#cfn-databrew-job-statisticoverride-parameters

statistic

The name of an evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html#cfn-databrew-job-statisticoverride-statistic

StatisticsConfigurationProperty

class CfnJobPropsMixin.StatisticsConfigurationProperty(*, included_statistics=None, overrides=None)

Bases: object

Configuration of evaluations for a profile job.

This configuration can be used to select evaluations and override the parameters of selected evaluations.

Parameters:

included_statistics (Optional[Sequence[str]]) – List of included evaluations. When the list is undefined, all supported evaluations will be included.
overrides (Union[IResolvable, Sequence[Union[IResolvable, StatisticOverrideProperty, Dict[str, Any]]], None]) – List of overrides for evaluations.

See:

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

statistics_configuration_property = databrew_mixins.CfnJobPropsMixin.StatisticsConfigurationProperty(
    included_statistics=["includedStatistics"],
    overrides=[databrew_mixins.CfnJobPropsMixin.StatisticOverrideProperty(
        parameters={
            "parameters_key": "parameters"
        },
        statistic="statistic"
    )]
)

Attributes

included_statistics

List of included evaluations.

When the list is undefined, all supported evaluations will be included.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html#cfn-databrew-job-statisticsconfiguration-includedstatistics

overrides

List of overrides for evaluations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html#cfn-databrew-job-statisticsconfiguration-overrides

ValidationConfigurationProperty

class CfnJobPropsMixin.ValidationConfigurationProperty(*, ruleset_arn=None, validation_mode=None)

Bases: object

Configuration for data quality validation.

Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.

Parameters:

ruleset_arn (Optional[str]) – The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.
validation_mode (Optional[str]) – Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.

See:

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

validation_configuration_property = databrew_mixins.CfnJobPropsMixin.ValidationConfigurationProperty(
    ruleset_arn="rulesetArn",
    validation_mode="validationMode"
)

Attributes

ruleset_arn

The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job.

The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-validationconfiguration.html#cfn-databrew-job-validationconfiguration-rulesetarn

validation_mode

Mode of data quality validation.

Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-validationconfiguration.html#cfn-databrew-job-validationconfiguration-validationmode