aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,046 lines • 132 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* Specifies a new DataBrew dataset.
*
* @cloudformationResource AWS::DataBrew::Dataset
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html
*/
export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDataset from CloudFormation properties
*
* 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;
/**
* The file format of a dataset that is created from an Amazon S3 file or folder.
*/
format?: string;
/**
* A set of options that define how DataBrew interprets the data in the dataset.
*/
formatOptions?: CfnDataset.FormatOptionsProperty | cdk.IResolvable;
/**
* Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
*/
input: CfnDataset.InputProperty | cdk.IResolvable;
/**
* The unique name of the dataset.
*/
name: string;
/**
* A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
*/
pathOptions?: cdk.IResolvable | CfnDataset.PathOptionsProperty;
/**
* The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .
*/
source?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Metadata tags that have been applied to the dataset.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnDatasetProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
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
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html
*/
interface InputProperty {
/**
* Connection information for dataset input files stored in a database.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-databaseinputdefinition
*/
readonly databaseInputDefinition?: CfnDataset.DatabaseInputDefinitionProperty | cdk.IResolvable;
/**
* The AWS Glue Data Catalog parameters for the data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-datacataloginputdefinition
*/
readonly dataCatalogInputDefinition?: CfnDataset.DataCatalogInputDefinitionProperty | cdk.IResolvable;
/**
* Contains additional resource information needed for specific datasets.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-metadata
*/
readonly metadata?: cdk.IResolvable | CfnDataset.MetadataProperty;
/**
* The Amazon S3 location where the data is stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-input.html#cfn-databrew-dataset-input-s3inputdefinition
*/
readonly s3InputDefinition?: cdk.IResolvable | CfnDataset.S3LocationProperty;
}
/**
* Connection information for dataset input files stored in a database.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html
*/
interface DatabaseInputDefinitionProperty {
/**
* The table within the target database.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-databasetablename
*/
readonly databaseTableName?: string;
/**
* The AWS Glue Connection that stores the connection information for the target database.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-glueconnectionname
*/
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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-databaseinputdefinition.html#cfn-databrew-dataset-databaseinputdefinition-tempdirectory
*/
readonly tempDirectory?: cdk.IResolvable | CfnDataset.S3LocationProperty;
}
/**
* 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
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html
*/
interface S3LocationProperty {
/**
* The Amazon S3 bucket name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucket
*/
readonly bucket: string;
/**
* The AWS account ID of the bucket owner.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-bucketowner
*/
readonly bucketOwner?: string;
/**
* The unique name of the object in the bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-s3location.html#cfn-databrew-dataset-s3location-key
*/
readonly key?: string;
}
/**
* Contains additional resource information needed for specific datasets.
*
* @struct
* @stability external
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-metadata.html#cfn-databrew-dataset-metadata-sourcearn
*/
readonly sourceArn?: string;
}
/**
* Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
*
* @struct
* @stability external
* @see 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.
*
* @see 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.
*
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datacataloginputdefinition.html#cfn-databrew-dataset-datacataloginputdefinition-tempdirectory
*/
readonly tempDirectory?: cdk.IResolvable | CfnDataset.S3LocationProperty;
}
/**
* Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input.
*
* @struct
* @stability external
* @see 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.
*
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-formatoptions.html#cfn-databrew-dataset-formatoptions-json
*/
readonly json?: cdk.IResolvable | CfnDataset.JsonOptionsProperty;
}
/**
* 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
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetindexes
*/
readonly sheetIndexes?: Array<number> | cdk.IResolvable;
/**
* One or more named sheets in the Excel file that will be included in the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetnames
*/
readonly sheetNames?: Array<string>;
}
/**
* 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
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-csvoptions.html#cfn-databrew-dataset-csvoptions-headerrow
*/
readonly headerRow?: boolean | cdk.IResolvable;
}
/**
* Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew .
*
* @struct
* @stability external
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-jsonoptions.html#cfn-databrew-dataset-jsonoptions-multiline
*/
readonly multiLine?: boolean | cdk.IResolvable;
}
/**
* Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.
*
* @struct
* @stability external
* @see 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.
*
* @see 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 .
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathoptions.html#cfn-databrew-dataset-pathoptions-parameters
*/
readonly parameters?: Array<cdk.IResolvable | CfnDataset.PathParameterProperty> | cdk.IResolvable;
}
/**
* Represents a single entry in the path parameters of a dataset.
*
* Each `PathParameter` consists of a name and a parameter definition.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html
*/
interface PathParameterProperty {
/**
* The path parameter definition.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-pathparameter.html#cfn-databrew-dataset-pathparameter-pathparametername
*/
readonly pathParameterName: string;
}
/**
* Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.
*
* @struct
* @stability external
* @see 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.
*
* @see 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.
*
* @see 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.
*
* @see 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.
*
* @see 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'.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datasetparameter.html#cfn-databrew-dataset-datasetparameter-type
*/
readonly type: string;
}
/**
* Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.
*
* @struct
* @stability external
* @see 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".
*
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-datetimeoptions.html#cfn-databrew-dataset-datetimeoptions-timezoneoffset
*/
readonly timezoneOffset?: string;
}
/**
* Represents a structure for defining parameter conditions.
*
* @struct
* @stability external
* @see 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.
*
* @see 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.
*
* @see 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;
}
/**
* 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
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-filtervalue.html#cfn-databrew-dataset-filtervalue-valuereference
*/
readonly valueReference: string;
}
/**
* 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
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html
*/
interface FilesLimitProperty {
/**
* The number of Amazon S3 files to select.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-maxfiles
*/
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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-fileslimit.html#cfn-databrew-dataset-fileslimit-orderedby
*/
readonly orderedBy?: string;
}
}
/**
* Properties for defining a `CfnDataset`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html
*/
export interface CfnDatasetProps {
/**
* The file format of a dataset that is created from an Amazon S3 file or folder.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-format
*/
readonly format?: string;
/**
* A set of options that define how DataBrew interprets the data in the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-formatoptions
*/
readonly formatOptions?: CfnDataset.FormatOptionsProperty | cdk.IResolvable;
/**
* Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-input
*/
readonly input: CfnDataset.InputProperty | cdk.IResolvable;
/**
* The unique name of the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-name
*/
readonly name: string;
/**
* A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-pathoptions
*/
readonly pathOptions?: cdk.IResolvable | CfnDataset.PathOptionsProperty;
/**
* The location of the data for the dataset, either Amazon S3 or the AWS Glue Data Catalog .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-source
*/
readonly source?: string;
/**
* Metadata tags that have been applied to the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html#cfn-databrew-dataset-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* Specifies a new DataBrew job.
*
* @cloudformationResource AWS::DataBrew::Job
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html
*/
export declare class CfnJob extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnJob from CloudFormation properties
*
* 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;
/**
* Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
*/
databaseOutputs?: Array<CfnJob.DatabaseOutputProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
*/
dataCatalogOutputs?: Array<CfnJob.DataCatalogOutputProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* A dataset that the job is to process.
*/
datasetName?: string;
/**
* The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
*/
encryptionKeyArn?: string;
/**
* The encryption mode for the job, which can be one of the following:.
*/
encryptionMode?: string;
/**
* A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
*/
jobSample?: cdk.IResolvable | CfnJob.JobSampleProperty;
/**
* The current status of Amazon CloudWatch logging for the job.
*/
logSubscription?: string;
/**
* The maximum number of nodes that can be consumed when the job processes data.
*/
maxCapacity?: number;
/**
* The maximum number of times to retry the job after a job run fails.
*/
maxRetries?: number;
/**
* The unique name of the job.
*/
name: string;
/**
* The location in Amazon S3 where the job writes its output.
*/
outputLocation?: cdk.IResolvable | CfnJob.OutputLocationProperty;
/**
* One or more artifacts that represent output from running the job.
*/
outputs?: Array<cdk.IResolvable | CfnJob.OutputProperty> | cdk.IResolvable;
/**
* Configuration for profile jobs.
*/
profileConfiguration?: cdk.IResolvable | CfnJob.ProfileConfigurationProperty;
/**
* The name of the project that the job is associated with.
*/
projectName?: string;
/**
* A series of data transformation steps that the job runs.
*/
recipe?: cdk.IResolvable | CfnJob.RecipeProperty;
/**
* The Amazon Resource Name (ARN) of the role to be assumed for this job.
*/
roleArn: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Metadata tags that have been applied to the job.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The job's timeout in minutes.
*/
timeout?: number;
/**
* The job type of the job, which must be one of the following:.
*/
type: string;
/**
* List of validation configurations that are applied to the profile job.
*/
validationConfigurations?: Array<cdk.IResolvable | CfnJob.ValidationConfigurationProperty> | cdk.IResolvable;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnJobProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnJob {
/**
* Represents one or more actions to be performed on a DataBrew dataset.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-recipe.html
*/
interface RecipeProperty {
/**
* 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
*/
readonly name: string;
/**
* 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
*/
readonly version?: string;
}
/**
* Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databaseoutput.html
*/
interface DatabaseOutputProperty {
/**
* 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
*/
readonly databaseOptions: CfnJob.DatabaseTableOutputOptionsProperty | cdk.IResolvable;
/**
* 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
*/
readonly databaseOutputMode?: string;
/**
* 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
*/
readonly glueConnectionName: string;
}
/**
* Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-databasetableoutputoptions.html
*/
interface DatabaseTableOutputOptionsProperty {
/**
* 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
*/
readonly tableName: string;
/**
* 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
*/
readonly tempDirectory?: cdk.IResolvable | CfnJob.S3LocationProperty;
}
/**
* 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
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-s3location.html
*/
interface S3LocationProperty {
/**
* 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
*/
readonly bucket: string;
/**
* 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
*/
readonly bucketOwner?: string;
/**
* 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
*/
readonly key?: string;
}
/**
* The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html
*/
interface OutputLocationProperty {
/**
* 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
*/
readonly bucket: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-outputlocation.html#cfn-databrew-job-outputlocation-bucketowner
*/
readonly bucketOwner?: string;
/**
* 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
*/
readonly key?: string;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-profileconfiguration.html
*/
interface ProfileConfigurationProperty {
/**
* 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
*/
readonly columnStatisticsConfigurations?: Array<CfnJob.ColumnStatisticsConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* 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
*/
readonly datasetStatisticsConfiguration?: cdk.IResolvable | CfnJob.StatisticsConfigurationProperty;
/**
* 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
*/
readonly entityDetectorConfiguration?: CfnJob.EntityDetectorConfigurationProperty | cdk.IResolvable;
/**
* 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
*/
readonly profileColumns?: Array<CfnJob.ColumnSelectorProperty | cdk.IResolvable> | cdk.IResolvable;
}
/**
* 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
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnselector.html
*/
interface ColumnSelectorProperty {
/**
* 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
*/
readonly name?: string;
/**
* 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
*/
readonly regex?: string;
}
/**
* Configuration of evaluations for a profile job.
*
* This configuration can be used to select evaluations and override the parameters of selected evaluations.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticsconfiguration.html
*/
interface StatisticsConfigurationProperty {
/**
* 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
*/
readonly includedStatistics?: Array<string>;
/**
* 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
*/
readonly overrides?: Array<cdk.IResolvable | CfnJob.StatisticOverrideProperty> | cdk.IResolvable;
}
/**
* Override of a particular evaluation for a profile job.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-statisticoverride.html
*/
interface StatisticOverrideProperty {
/**
* 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
*/
readonly parameters: cdk.IResolvable | Record<string, string>;
/**
* 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
*/
readonly statistic: string;
}
/**
* 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
* @see 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.
*
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-columnstatisticsconfiguration.html#cfn-databrew-job-columnstatisticsconfiguration-statistics
*/
readonly statistics: cdk.IResolvable | CfnJob.StatisticsConfigurationProperty;
}
/**
* Configuration of entity detection for a profile job.
*
* When undefined, entity detection is disabled.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html
*/
interface EntityDetectorConfigurationProperty {
/**
* 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
*/
readonly allowedStatistics?: CfnJob.AllowedStatisticsProperty | cdk.IResolvable;
/**
* 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#cfn-databrew-job-entitydetectorconfiguration-entitytypes
*/
readonly entityTypes: Array<string>;
}
/**
* 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
* @see 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.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-allowedstatistics.html#cfn-databrew-job-allowedstatistics-statistics
*/
readonly statistics: Array<string>;
}
/**
* Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html
*/
interface OutputProperty {
/**
* 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
*/
readonly compressionFormat?: string;
/**
* 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
*/
readonly format?: string;
/**
* 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
*/
readonly formatOptions?: cdk.IResolvable | CfnJob.OutputFormatOptionsProperty;
/**
* 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
*/
readonly location: cdk.IResolvable | CfnJob.S3LocationProperty;
/