UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,019 lines 140 kB
import * as constructs from 'constructs'; import * as cdk from '../../core'; import * as cfn_parse from '../../core/lib/helpers-internal'; /** * Properties for defining a `CfnDataset` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html */ export interface CfnDatasetProps { /** * Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-input */ readonly input: CfnDataset.InputProperty | cdk.IResolvable; /** * The unique name of the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-name */ readonly name: string; /** * The file format of a dataset that is created from an Amazon S3 file or folder. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-format */ readonly format?: string; /** * A set of options that define how DataBrew interprets the data in the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-formatoptions */ readonly formatOptions?: CfnDataset.FormatOptionsProperty | cdk.IResolvable; /** * A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-pathoptions */ readonly pathOptions?: CfnDataset.PathOptionsProperty | cdk.IResolvable; /** * Metadata tags that have been applied to the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-tags */ readonly tags?: cdk.CfnTag[]; } /** * A CloudFormation `AWS::DataBrew::Dataset` * * Specifies a new DataBrew dataset. * * @cloudformationResource AWS::DataBrew::Dataset * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html */ export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::DataBrew::Dataset"; /** * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataset; /** * Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-input */ input: CfnDataset.InputProperty | cdk.IResolvable; /** * The unique name of the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-name */ name: string; /** * The file format of a dataset that is created from an Amazon S3 file or folder. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-format */ format: string | undefined; /** * A set of options that define how DataBrew interprets the data in the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-formatoptions */ formatOptions: CfnDataset.FormatOptionsProperty | cdk.IResolvable | undefined; /** * A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-pathoptions */ pathOptions: CfnDataset.PathOptionsProperty | cdk.IResolvable | undefined; /** * Metadata tags that have been applied to the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-tags */ readonly tags: cdk.TagManager; /** * Create a new `AWS::DataBrew::Dataset`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDatasetProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; } export declare namespace CfnDataset { /** * Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html */ interface CsvOptionsProperty { /** * A single character that specifies the delimiter being used in the CSV file. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-delimiter */ readonly delimiter?: string; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-headerrow */ readonly headerRow?: boolean | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html */ interface DataCatalogInputDefinitionProperty { /** * The unique identifier of the AWS account that holds the Data Catalog that stores the data. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-catalogid */ readonly catalogId?: string; /** * The name of a database in the Data Catalog. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-databasename */ readonly databaseName?: string; /** * The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tablename */ readonly tableName?: string; /** * An Amazon location that AWS Glue Data Catalog can use as a temporary directory. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory */ readonly tempDirectory?: CfnDataset.S3LocationProperty | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Connection information for dataset input files stored in a database. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html */ interface DatabaseInputDefinitionProperty { /** * The table within the target database. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-databasetablename */ readonly databaseTableName?: string; /** * The AWS Glue Connection that stores the connection information for the target database. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname */ readonly glueConnectionName: string; /** * Custom SQL to run against the provided AWS Glue connection. This SQL will be used as the input for DataBrew projects and jobs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-querystring */ readonly queryString?: string; /** * An Amazon location that AWS Glue Data Catalog can use as a temporary directory. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-tempdirectory */ readonly tempDirectory?: CfnDataset.S3LocationProperty | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html */ interface DatasetParameterProperty { /** * Optional boolean value that defines whether the captured value of this parameter should be loaded as an additional column in the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-createcolumn */ readonly createColumn?: boolean | cdk.IResolvable; /** * Additional parameter options such as a format and a timezone. Required for datetime parameters. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-datetimeoptions */ readonly datetimeOptions?: CfnDataset.DatetimeOptionsProperty | cdk.IResolvable; /** * The optional filter expression structure to apply additional matching criteria to the parameter. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-filter */ readonly filter?: CfnDataset.FilterExpressionProperty | cdk.IResolvable; /** * The name of the parameter that is used in the dataset's Amazon S3 path. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-name */ readonly name: string; /** * The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-type */ readonly type: string; } } export declare namespace CfnDataset { /** * Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html */ interface DatetimeOptionsProperty { /** * 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". * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-format */ readonly format: string; /** * Optional value for a non-US locale code, needed for correct interpretation of some date formats. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-localecode */ readonly localeCode?: string; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-timezoneoffset */ readonly timezoneOffset?: string; } } export declare namespace CfnDataset { /** * Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html */ interface ExcelOptionsProperty { /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-headerrow */ readonly headerRow?: boolean | cdk.IResolvable; /** * One or more sheet numbers in the Excel file that will be included in the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetindexes */ readonly sheetIndexes?: number[] | cdk.IResolvable; /** * One or more named sheets in the Excel file that will be included in the dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetnames */ readonly sheetNames?: string[]; } } export declare namespace CfnDataset { /** * Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html */ interface FilesLimitProperty { /** * The number of Amazon S3 files to select. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-maxfiles */ readonly maxFiles: number; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-order */ readonly order?: string; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-orderedby */ readonly orderedBy?: string; } } export declare namespace CfnDataset { /** * Represents a structure for defining parameter conditions. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html */ interface FilterExpressionProperty { /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-expression */ readonly expression: string; /** * The map of substitution variable names to their values used in this filter expression. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filterexpression.html#cfn-databrew-dataset-filterexpression-valuesmap */ readonly valuesMap: Array<CfnDataset.FilterValueProperty | cdk.IResolvable> | cdk.IResolvable; } } export declare namespace CfnDataset { /** * 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. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html */ interface FilterValueProperty { /** * The value to be associated with the substitution variable. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-value */ readonly value: string; /** * The substitution variable reference. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-valuereference */ readonly valueReference: string; } } export declare namespace CfnDataset { /** * Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html */ interface FormatOptionsProperty { /** * Options that define how CSV input is to be interpreted by DataBrew. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-csv */ readonly csv?: CfnDataset.CsvOptionsProperty | cdk.IResolvable; /** * Options that define how Excel input is to be interpreted by DataBrew. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-excel */ readonly excel?: CfnDataset.ExcelOptionsProperty | cdk.IResolvable; /** * Options that define how JSON input is to be interpreted by DataBrew. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-json */ readonly json?: CfnDataset.JsonOptionsProperty | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Represents information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html */ interface InputProperty { /** * The AWS Glue Data Catalog parameters for the data. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-datacataloginputdefinition */ readonly dataCatalogInputDefinition?: CfnDataset.DataCatalogInputDefinitionProperty | cdk.IResolvable; /** * Connection information for dataset input files stored in a database. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-databaseinputdefinition */ readonly databaseInputDefinition?: CfnDataset.DatabaseInputDefinitionProperty | cdk.IResolvable; /** * Contains additional resource information needed for specific datasets. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-metadata */ readonly metadata?: CfnDataset.MetadataProperty | cdk.IResolvable; /** * The Amazon S3 location where the data is stored. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-s3inputdefinition */ readonly s3InputDefinition?: CfnDataset.S3LocationProperty | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew . * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html */ interface JsonOptionsProperty { /** * A value that specifies whether JSON input contains embedded new line characters. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html#cfn-databrew-dataset-jsonoptions-multiline */ readonly multiLine?: boolean | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Contains additional resource information needed for specific datasets. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html */ interface MetadataProperty { /** * The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html#cfn-databrew-dataset-metadata-sourcearn */ readonly sourceArn?: string; } } export declare namespace CfnDataset { /** * Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html */ interface PathOptionsProperty { /** * If provided, this structure imposes a limit on a number of files that should be selected. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-fileslimit */ readonly filesLimit?: CfnDataset.FilesLimitProperty | cdk.IResolvable; /** * If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3 . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-lastmodifieddatecondition */ readonly lastModifiedDateCondition?: CfnDataset.FilterExpressionProperty | cdk.IResolvable; /** * A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-parameters */ readonly parameters?: Array<CfnDataset.PathParameterProperty | cdk.IResolvable> | cdk.IResolvable; } } export declare namespace CfnDataset { /** * Represents a single entry in the path parameters of a dataset. Each `PathParameter` consists of a name and a parameter definition. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html */ interface PathParameterProperty { /** * The path parameter definition. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-datasetparameter */ readonly datasetParameter: CfnDataset.DatasetParameterProperty | cdk.IResolvable; /** * The name of the path parameter. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-pathparametername */ readonly pathParameterName: string; } } export declare namespace CfnDataset { /** * Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html */ interface S3LocationProperty { /** * The Amazon S3 bucket name. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucket */ readonly bucket: string; /** * The unique name of the object in the bucket. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-key */ readonly key?: string; } } /** * Properties for defining a `CfnJob` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html */ export interface CfnJobProps { /** * The unique name of the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-name */ readonly name: string; /** * The Amazon Resource Name (ARN) of the role to be assumed for this job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-rolearn */ readonly roleArn: string; /** * The job type of the job, which must be one of the following: * * - `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. * - `RECIPE` - A job to apply one or more transformations to a dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-type */ readonly type: string; /** * Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs */ readonly databaseOutputs?: Array<CfnJob.DatabaseOutputProperty | cdk.IResolvable> | cdk.IResolvable; /** * One or more artifacts that represent the AWS Glue Data Catalog output from running the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs */ readonly dataCatalogOutputs?: Array<CfnJob.DataCatalogOutputProperty | cdk.IResolvable> | cdk.IResolvable; /** * A dataset that the job is to process. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datasetname */ readonly datasetName?: string; /** * The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn */ readonly encryptionKeyArn?: string; /** * The encryption mode for the job, which can be one of the following: * * - `SSE-KMS` - Server-side encryption with keys managed by AWS KMS . * - `SSE-S3` - Server-side encryption with keys managed by Amazon S3. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode */ readonly encryptionMode?: string; /** * 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 value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample */ readonly jobSample?: CfnJob.JobSampleProperty | cdk.IResolvable; /** * The current status of Amazon CloudWatch logging for the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription */ readonly logSubscription?: string; /** * The maximum number of nodes that can be consumed when the job processes data. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity */ readonly maxCapacity?: number; /** * The maximum number of times to retry the job after a job run fails. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries */ readonly maxRetries?: number; /** * `AWS::DataBrew::Job.OutputLocation` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation */ readonly outputLocation?: CfnJob.OutputLocationProperty | cdk.IResolvable; /** * One or more artifacts that represent output from running the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputs */ readonly outputs?: Array<CfnJob.OutputProperty | cdk.IResolvable> | cdk.IResolvable; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration */ readonly profileConfiguration?: CfnJob.ProfileConfigurationProperty | cdk.IResolvable; /** * The name of the project that the job is associated with. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname */ readonly projectName?: string; /** * A series of data transformation steps that the job runs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe */ readonly recipe?: CfnJob.RecipeProperty | cdk.IResolvable; /** * Metadata tags that have been applied to the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags */ readonly tags?: cdk.CfnTag[]; /** * The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout */ readonly timeout?: number; /** * List of validation configurations that are applied to the profile job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations */ readonly validationConfigurations?: Array<CfnJob.ValidationConfigurationProperty | cdk.IResolvable> | cdk.IResolvable; } /** * A CloudFormation `AWS::DataBrew::Job` * * Specifies a new DataBrew job. * * @cloudformationResource AWS::DataBrew::Job * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html */ export declare class CfnJob extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::DataBrew::Job"; /** * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnJob; /** * The unique name of the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-name */ name: string; /** * The Amazon Resource Name (ARN) of the role to be assumed for this job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-rolearn */ roleArn: string; /** * The job type of the job, which must be one of the following: * * - `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. * - `RECIPE` - A job to apply one or more transformations to a dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-type */ type: string; /** * Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs */ databaseOutputs: Array<CfnJob.DatabaseOutputProperty | cdk.IResolvable> | cdk.IResolvable | undefined; /** * One or more artifacts that represent the AWS Glue Data Catalog output from running the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs */ dataCatalogOutputs: Array<CfnJob.DataCatalogOutputProperty | cdk.IResolvable> | cdk.IResolvable | undefined; /** * A dataset that the job is to process. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datasetname */ datasetName: string | undefined; /** * The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html) * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn */ encryptionKeyArn: string | undefined; /** * The encryption mode for the job, which can be one of the following: * * - `SSE-KMS` - Server-side encryption with keys managed by AWS KMS . * - `SSE-S3` - Server-side encryption with keys managed by Amazon S3. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode */ encryptionMode: string | undefined; /** * 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 value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample */ jobSample: CfnJob.JobSampleProperty | cdk.IResolvable | undefined; /** * The current status of Amazon CloudWatch logging for the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription */ logSubscription: string | undefined; /** * The maximum number of nodes that can be consumed when the job processes data. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity */ maxCapacity: number | undefined; /** * The maximum number of times to retry the job after a job run fails. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries */ maxRetries: number | undefined; /** * `AWS::DataBrew::Job.OutputLocation` * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation */ outputLocation: CfnJob.OutputLocationProperty | cdk.IResolvable | undefined; /** * One or more artifacts that represent output from running the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputs */ outputs: Array<CfnJob.OutputProperty | cdk.IResolvable> | cdk.IResolvable | undefined; /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration */ profileConfiguration: CfnJob.ProfileConfigurationProperty | cdk.IResolvable | undefined; /** * The name of the project that the job is associated with. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname */ projectName: string | undefined; /** * A series of data transformation steps that the job runs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe */ recipe: CfnJob.RecipeProperty | cdk.IResolvable | undefined; /** * Metadata tags that have been applied to the job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags */ readonly tags: cdk.TagManager; /** * The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout */ timeout: number | undefined; /** * List of validation configurations that are applied to the profile job. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations */ validationConfigurations: Array<CfnJob.ValidationConfigurationProperty | cdk.IResolvable> | cdk.IResolvable | undefined; /** * Create a new `AWS::DataBrew::Job`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnJobProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; } export declare namespace CfnJob { /** * 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. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html */ interface AllowedStatisticsProperty { /** * One or more column statistics to allow for columns that contain detected entities. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html#cfn-databrew-job-allowedstatistics-statistics */ readonly statistics: string[]; } } export declare namespace CfnJob { /** * Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html */ interface ColumnSelectorProperty { /** * The name of a column from a dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-name */ readonly name?: string; /** * A regular expression for selecting a column from a dataset. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html#cfn-databrew-job-columnselector-regex */ readonly regex?: string; } } export declare namespace CfnJob { /** * Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html */ interface ColumnStatisticsConfigurationProperty { /** * 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. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-selectors */ readonly selectors?: Array<CfnJob.ColumnSelectorProperty | cdk.IResolvable> | cdk.IResolvable; /** * Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-statistics */ readonly statistics: CfnJob.StatisticsConfigurationProperty | cdk.IResolvable; } } export declare namespace CfnJob { /** * Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.html */ interface CsvOutputOptionsProperty { /** * A single character that specifies the delimiter used to create CSV job output. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-csvoutputoptions.html#cfn-databrew-job-csvoutputoptions-delimiter */ readonly delimiter?: string; } } export declare namespace CfnJob { /** * Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs. * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html */ interface DataCatalogOutputProperty { /** * The unique identifier of the AWS account that holds the Data Catalog that stores the data. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-catalogid */ readonly catalogId?: string; /** * The name of a database in the Data Catalog. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databasename */ readonly databaseName: string; /** * Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databaseoptions */ readonly databaseOptions?: CfnJob.DatabaseTableOutputOptionsProperty | cdk.IResolvable; /** * A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-overwrite */ readonly overwrite?: boolean | cdk.IResolvable; /** * Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuid