@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-databrew-recipe.d.ts

@@ -0,0 +1,548 @@
+import type { ResourceDefinition, Tag } from "../main.ts";
+export type DataBrewRecipe = ResourceDefinition<"AWS::DataBrew::Recipe", DataBrewRecipeProps>;
+/**
+ * Specifies a new AWS Glue DataBrew transformation recipe.
+ */
+export type DataBrewRecipeProps = {
+    /**
+     * The description of the recipe.
+     * @minLength 0
+     * @maxLength 1024
+     */
+    Description?: string | undefined;
+    /**
+     * The unique name for the recipe.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name: string;
+    /**
+     * A list of steps that are defined by the recipe.
+     */
+    Steps: RecipeStep[];
+    /**
+     * Metadata tags that have been applied to the recipe.
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset.
+ */
+export type Action = {
+    /**
+     * The name of a valid DataBrew transformation to be performed on the data.
+     */
+    Operation: string;
+    /**
+     * Contextual parameters for the transformation.
+     */
+    Parameters?: RecipeParameters | Record<string, string> | undefined;
+};
+/**
+ * Represents an individual condition that evaluates to true or false.
+ *
+ * Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.
+ *
+ * If a recipe requires more than one condition, then the recipe must specify multiple `ConditionExpression` elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.
+ */
+export type ConditionExpression = {
+    /**
+     * A specific condition to apply to a recipe action. For more information, see [Recipe structure](https://docs.aws.amazon.com/databrew/latest/dg/recipe-structure.html) in the *AWS Glue DataBrew Developer Guide* .
+     */
+    Condition: string;
+    /**
+     * A column to apply this condition to.
+     */
+    TargetColumn: string;
+    /**
+     * A value that the condition must evaluate to for the condition to succeed.
+     */
+    Value?: string | undefined;
+};
+/**
+ * Represents how metadata stored in the AWS Glue Data Catalog is defined in a DataBrew dataset.
+ */
+export type DataCatalogInputDefinition = {
+    /**
+     * The unique identifier of the AWS account that holds the Data Catalog that stores the data.
+     */
+    CatalogId?: string | undefined;
+    /**
+     * The name of a database in the Data Catalog.
+     */
+    DatabaseName?: string | undefined;
+    /**
+     * The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset.
+     */
+    TableName?: string | undefined;
+    /**
+     * Represents an Amazon location where DataBrew can store intermediate results.
+     */
+    TempDirectory?: S3Location | undefined;
+};
+/**
+ * Parameters that are used as inputs for various recipe actions. The parameters are specific to the context in which they're used.
+ */
+export type RecipeParameters = {
+    /**
+     * The name of an aggregation function to apply.
+     */
+    AggregateFunction?: string | undefined;
+    /**
+     * The number of digits used in a counting system.
+     */
+    Base?: string | undefined;
+    /**
+     * A case statement associated with a recipe.
+     */
+    CaseStatement?: string | undefined;
+    /**
+     * A category map used for one-hot encoding.
+     */
+    CategoryMap?: string | undefined;
+    /**
+     * Characters to remove from a step that applies one-hot encoding or tokenization.
+     */
+    CharsToRemove?: string | undefined;
+    /**
+     * Remove any non-word non-punctuation character.
+     */
+    CollapseConsecutiveWhitespace?: string | undefined;
+    /**
+     * The data type of the column.
+     */
+    ColumnDataType?: string | undefined;
+    /**
+     * A range of columns to which a step is applied.
+     */
+    ColumnRange?: string | undefined;
+    /**
+     * The number of times a string needs to be repeated.
+     */
+    Count?: string | undefined;
+    /**
+     * One or more characters that can be substituted or removed, depending on the context.
+     */
+    CustomCharacters?: string | undefined;
+    /**
+     * A list of words to ignore in a step that applies word tokenization.
+     */
+    CustomStopWords?: string | undefined;
+    /**
+     * A list of custom values to use in a step that requires that you provide a value to finish the operation.
+     */
+    CustomValue?: string | undefined;
+    /**
+     * A list of the dataset columns included in a project.
+     */
+    DatasetsColumns?: string | undefined;
+    /**
+     * A value that specifies how many units of time to add or subtract for a date math operation.
+     */
+    DateAddValue?: string | undefined;
+    /**
+     * A date format to apply to a date.
+     */
+    DateTimeFormat?: string | undefined;
+    /**
+     * A set of parameters associated with a datetime.
+     */
+    DateTimeParameters?: string | undefined;
+    /**
+     * Determines whether unmapped rows in a categorical mapping should be deleted
+     */
+    DeleteOtherRows?: string | undefined;
+    /**
+     * The delimiter to use when parsing separated values in a text file.
+     */
+    Delimiter?: string | undefined;
+    /**
+     * The end pattern to locate.
+     */
+    EndPattern?: string | undefined;
+    /**
+     * The end position to locate.
+     */
+    EndPosition?: string | undefined;
+    /**
+     * The end value to locate.
+     */
+    EndValue?: string | undefined;
+    /**
+     * A list of word contractions and what they expand to. For eample: *can't* ; *cannot* ; *can not* .
+     */
+    ExpandContractions?: string | undefined;
+    /**
+     * The exponent to apply in an exponential operation.
+     */
+    Exponent?: string | undefined;
+    /**
+     * A value that represents `FALSE` .
+     */
+    FalseString?: string | undefined;
+    /**
+     * Specifies options to apply to the `GROUP BY` used in an aggregation.
+     */
+    GroupByAggFunctionOptions?: string | undefined;
+    /**
+     * The columns to use in the `GROUP BY` clause.
+     */
+    GroupByColumns?: string | undefined;
+    /**
+     * A list of columns to hide.
+     */
+    HiddenColumns?: string | undefined;
+    /**
+     * Indicates that lower and upper case letters are treated equally.
+     */
+    IgnoreCase?: string | undefined;
+    /**
+     * Indicates if this column is participating in a split transform.
+     */
+    IncludeInSplit?: string | undefined;
+    /**
+     * The input location to load the dataset from - Amazon S3 or AWS Glue Data Catalog .
+     */
+    Input?: {
+        DataCatalogInputDefinition?: DataCatalogInputDefinition | undefined;
+        S3InputDefinition: S3Location;
+    } | {
+        DataCatalogInputDefinition: DataCatalogInputDefinition;
+        S3InputDefinition?: S3Location | undefined;
+    } | undefined;
+    /**
+     * The number of characters to split by.
+     */
+    Interval?: string | undefined;
+    /**
+     * Indicates if the content is text.
+     */
+    IsText?: string | undefined;
+    /**
+     * The keys or columns involved in a join.
+     */
+    JoinKeys?: string | undefined;
+    /**
+     * The type of join to use, for example, `INNER JOIN` , `OUTER JOIN` , and so on.
+     */
+    JoinType?: string | undefined;
+    /**
+     * The columns on the left side of the join.
+     */
+    LeftColumns?: string | undefined;
+    /**
+     * The number of times to perform `split` or `replaceBy` in a string
+     */
+    Limit?: string | undefined;
+    /**
+     * The lower boundary for a value.
+     */
+    LowerBound?: string | undefined;
+    /**
+     * The type of mappings to apply to construct a new dynamic frame.
+     */
+    MapType?: string | undefined;
+    /**
+     * Determines the manner in which mode value is calculated, in case there is more than one mode value. Valid values: `NONE` | `AVERAGE` | `MINIMUM` | `MAXIMUM`
+     */
+    ModeType?: string | undefined;
+    /**
+     * Specifies whether JSON input contains embedded new line characters.
+     */
+    MultiLine?: boolean | undefined;
+    /**
+     * The number of rows to consider in a window.
+     */
+    NumRows?: string | undefined;
+    /**
+     * The number of rows to consider after the current row in a window
+     */
+    NumRowsAfter?: string | undefined;
+    /**
+     * The number of rows to consider before the current row in a window
+     */
+    NumRowsBefore?: string | undefined;
+    /**
+     * A column to sort the results by.
+     */
+    OrderByColumn?: string | undefined;
+    /**
+     * The columns to sort the results by.
+     */
+    OrderByColumns?: string | undefined;
+    /**
+     * The value to assign to unmapped cells, in categorical mapping
+     */
+    Other?: string | undefined;
+    /**
+     * The pattern to locate.
+     */
+    Pattern?: string | undefined;
+    /**
+     * The starting pattern to split between.
+     */
+    PatternOption1?: string | undefined;
+    /**
+     * The ending pattern to split between.
+     */
+    PatternOption2?: string | undefined;
+    /**
+     * For splitting by multiple delimiters: A JSON-encoded string that lists the patterns in the format. For example: `[{\"pattern\":\"1\",\"includeInSplit\":true}]`
+     */
+    PatternOptions?: string | undefined;
+    /**
+     * The size of the rolling window.
+     */
+    Period?: string | undefined;
+    /**
+     * The character index within a string
+     */
+    Position?: string | undefined;
+    /**
+     * If `true` , removes all of the following characters: `.` `.!` `.,` `.?`
+     */
+    RemoveAllPunctuation?: string | undefined;
+    /**
+     * If `true` , removes all single quotes and double quotes.
+     */
+    RemoveAllQuotes?: string | undefined;
+    /**
+     * If `true` , removes all whitespaces from the value.
+     */
+    RemoveAllWhitespace?: string | undefined;
+    /**
+     * If `true` , removes all chraracters specified by `CustomCharacters` .
+     */
+    RemoveCustomCharacters?: string | undefined;
+    /**
+     * If `true` , removes all chraracters specified by `CustomValue` .
+     */
+    RemoveCustomValue?: string | undefined;
+    /**
+     * If `true` , removes the following characters if they occur at the start or end of the value: `.` `!` `,` `?`
+     */
+    RemoveLeadingAndTrailingPunctuation?: string | undefined;
+    /**
+     * If `true` , removes single quotes and double quotes from the beginning and end of the value.
+     */
+    RemoveLeadingAndTrailingQuotes?: string | undefined;
+    /**
+     * If `true` , removes all whitespaces from the beginning and end of the value.
+     */
+    RemoveLeadingAndTrailingWhitespace?: string | undefined;
+    /**
+     * If `true` , removes all uppercase and lowercase alphabetic characters (A through Z; a through z).
+     */
+    RemoveLetters?: string | undefined;
+    /**
+     * If `true` , removes all numeric characters (0 through 9).
+     */
+    RemoveNumbers?: string | undefined;
+    /**
+     * If `true` , the source column will be removed after un-nesting that column. (Used with nested column types, such as Map, Struct, or Array.)
+     */
+    RemoveSourceColumn?: string | undefined;
+    /**
+     * If `true` , removes all of the following characters: `! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~`
+     */
+    RemoveSpecialCharacters?: string | undefined;
+    /**
+     * The columns on the right side of a join.
+     */
+    RightColumns?: string | undefined;
+    /**
+     * The number of rows in the sample.
+     */
+    SampleSize?: string | undefined;
+    /**
+     * The sampling type to apply to the dataset. Valid values: `FIRST_N` | `LAST_N` | `RANDOM`
+     */
+    SampleType?: string | undefined;
+    /**
+     * A object value to indicate the second dataset used in a join.
+     */
+    SecondInput?: string | undefined;
+    /**
+     * A list of secondary inputs in a UNION transform
+     */
+    SecondaryInputs?: SecondaryInput[] | undefined;
+    /**
+     * One or more sheet numbers in the Excel file, which will be included in a dataset.
+     */
+    SheetIndexes?: number[] | undefined;
+    /**
+     * Oone or more named sheets in the Excel file, which will be included in a dataset.
+     */
+    SheetNames?: string[] | undefined;
+    /**
+     * A source column needed for an operation, step, or transform.
+     */
+    SourceColumn?: string | undefined;
+    /**
+     * A source column needed for an operation, step, or transform.
+     */
+    SourceColumn1?: string | undefined;
+    /**
+     * A source column needed for an operation, step, or transform.
+     */
+    SourceColumn2?: string | undefined;
+    /**
+     * A list of source columns needed for an operation, step, or transform.
+     */
+    SourceColumns?: string | undefined;
+    /**
+     * The index number of the first column used by an operation, step, or transform.
+     */
+    StartColumnIndex?: string | undefined;
+    /**
+     * The starting pattern to locate.
+     */
+    StartPattern?: string | undefined;
+    /**
+     * The starting position to locate.
+     */
+    StartPosition?: string | undefined;
+    /**
+     * The starting value to locate.
+     */
+    StartValue?: string | undefined;
+    /**
+     * Indicates this operation uses stems and lemmas (base words) for word tokenization.
+     */
+    StemmingMode?: string | undefined;
+    /**
+     * The total number of transforms in this recipe.
+     */
+    StepCount?: string | undefined;
+    /**
+     * The index ID of a step.
+     */
+    StepIndex?: string | undefined;
+    /**
+     * Indicates this operation uses stop words as part of word tokenization.
+     */
+    StopWordsMode?: string | undefined;
+    /**
+     * The resolution strategy to apply in resolving ambiguities.
+     */
+    Strategy?: string | undefined;
+    /**
+     * The column targeted by this operation.
+     */
+    TargetColumn?: string | undefined;
+    /**
+     * The names to give columns altered by this operation.
+     */
+    TargetColumnNames?: string | undefined;
+    /**
+     * The date format to convert to.
+     */
+    TargetDateFormat?: string | undefined;
+    /**
+     * The index number of an object that is targeted by this operation.
+     */
+    TargetIndex?: string | undefined;
+    /**
+     * The current timezone that you want to use for dates.
+     */
+    TimeZone?: string | undefined;
+    /**
+     * A regex expression to use when splitting text into terms, also called words or tokens.
+     */
+    TokenizerPattern?: string | undefined;
+    /**
+     * A value to use to represent `TRUE` .
+     */
+    TrueString?: string | undefined;
+    /**
+     * The language that's used in the user-defined function.
+     */
+    UdfLang?: string | undefined;
+    /**
+     * Specifies a unit of time. For example: `MINUTES` ; `SECONDS` ; `HOURS` ; etc.
+     */
+    Units?: string | undefined;
+    /**
+     * Cast columns as rows, so that each value is a different row in a single column.
+     */
+    UnpivotColumn?: string | undefined;
+    /**
+     * The upper boundary for a value.
+     */
+    UpperBound?: string | undefined;
+    /**
+     * Create a new container to hold a dataset.
+     */
+    UseNewDataFrame?: string | undefined;
+    /**
+     * A static value that can be used in a comparison, a substitution, or in another context-specific way. A `Value` can be a number, string, or other datatype, depending on the recipe action in which it's used.
+     */
+    Value?: string | undefined;
+    /**
+     * A value that's used by this operation.
+     */
+    Value1?: string | undefined;
+    /**
+     * A value that's used by this operation.
+     */
+    Value2?: string | undefined;
+    /**
+     * The column that is provided as a value that's used by this operation.
+     */
+    ValueColumn?: string | undefined;
+    /**
+     * The subset of rows currently available for viewing.
+     */
+    ViewFrame?: string | undefined;
+};
+/**
+ * Represents a single step from a DataBrew recipe to be performed.
+ */
+export type RecipeStep = {
+    /**
+     * The particular action to be performed in the recipe step.
+     */
+    Action: Action;
+    /**
+     * One or more conditions that must be met for the recipe step to succeed.
+     *
+     * > All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.
+     */
+    ConditionExpressions?: ConditionExpression[] | undefined;
+};
+/**
+ * Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
+ */
+export type S3Location = {
+    /**
+     * The Amazon S3 bucket name.
+     */
+    Bucket: string;
+    /**
+     * The unique name of the object in the bucket.
+     */
+    Key?: string | undefined;
+};
+/**
+ * Represents secondary inputs in a UNION transform.
+ */
+export type SecondaryInput = {
+    /**
+     * The AWS Glue Data Catalog parameters for the data.
+     */
+    DataCatalogInputDefinition?: DataCatalogInputDefinition | undefined;
+    /**
+     * The Amazon S3 location where the data is stored.
+     */
+    S3InputDefinition: S3Location;
+} | {
+    /**
+     * The AWS Glue Data Catalog parameters for the data.
+     */
+    DataCatalogInputDefinition: DataCatalogInputDefinition;
+    /**
+     * The Amazon S3 location where the data is stored.
+     */
+    S3InputDefinition?: S3Location | undefined;
+};
+//# sourceMappingURL=aws-databrew-recipe.d.ts.map

package/out/exports/resources.generated/aws-databrew-ruleset.d.ts

@@ -0,0 +1,126 @@
+import type { ResourceDefinition, Tag } from "../main.ts";
+export type DataBrewRuleset = ResourceDefinition<"AWS::DataBrew::Ruleset", DataBrewRulesetProps>;
+/**
+ * Specifies a new ruleset that can be used in a profile job to validate the data quality of a dataset.
+ */
+export type DataBrewRulesetProps = {
+    /**
+     * The description of the ruleset.
+     * @maxLength 1024
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the ruleset.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name: string;
+    /**
+     * Contains metadata about the ruleset.
+     */
+    Rules: Rule[];
+    /**
+     * An array of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    TargetArn: string;
+};
+/**
+ * Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.
+ */
+export type ColumnSelector = {
+    /**
+     * The name of a column from a dataset.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name?: string | undefined;
+    /**
+     * A regular expression for selecting a column from a dataset.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Regex?: string | undefined;
+};
+/**
+ * Represents a single data quality requirement that should be validated in the scope of this dataset.
+ */
+export type Rule = {
+    /**
+     * The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, `(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)` . Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, `is_between :val1 and :val2` .
+     */
+    CheckExpression: string;
+    /**
+     * List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.
+     */
+    ColumnSelectors?: ColumnSelector[] | undefined;
+    /**
+     * A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.
+     */
+    Disabled?: boolean | undefined;
+    /**
+     * The name of the rule.
+     * @minLength 1
+     * @maxLength 128
+     */
+    Name: string;
+    /**
+     * The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, `":col1": "`Column A`".`
+     */
+    SubstitutionMap?: SubstitutionValue[] | undefined;
+    /**
+     * The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.
+     */
+    Threshold?: Threshold | undefined;
+};
+/**
+ * A key-value pair to associate an expression's substitution variable names with their values.
+ */
+export type SubstitutionValue = {
+    /**
+     * Value or column name.
+     * @minLength 0
+     * @maxLength 1024
+     */
+    Value: string;
+    /**
+     * Variable name.
+     * @minLength 2
+     * @maxLength 128
+     * @pattern ^:[A-Za-z0-9_]+$
+     */
+    ValueReference: string;
+};
+/**
+ * The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.
+ */
+export type Threshold = {
+    /**
+     * The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.
+     */
+    Type?: ThresholdType | undefined;
+    /**
+     * Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.
+     */
+    Unit?: ThresholdUnit | undefined;
+    /**
+     * The value of a threshold.
+     */
+    Value: number;
+};
+/**
+ * Threshold type for a rule
+ */
+export type ThresholdType = "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL" | "GREATER_THAN" | "LESS_THAN";
+/**
+ * Threshold unit for a rule
+ */
+export type ThresholdUnit = "COUNT" | "PERCENTAGE";
+//# sourceMappingURL=aws-databrew-ruleset.d.ts.map

package/out/exports/resources.generated/aws-databrew-schedule.d.ts

@@ -0,0 +1,28 @@
+import type { ResourceDefinition, Tag } from "../main.ts";
+export type DataBrewSchedule = ResourceDefinition<"AWS::DataBrew::Schedule", DataBrewScheduleProps>;
+/**
+ * Specifies a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.
+ */
+export type DataBrewScheduleProps = {
+    /**
+     * The dates and times when the job is to run. For more information, see [Working with cron expressions for recipe jobs](https://docs.aws.amazon.com/databrew/latest/dg/jobs.recipe.html#jobs.cron) in the *AWS Glue DataBrew Developer Guide* .
+     * @minLength 1
+     * @maxLength 512
+     */
+    CronExpression: string;
+    /**
+     * A list of jobs to be run, according to the schedule.
+     */
+    JobNames?: string[] | undefined;
+    /**
+     * The name of the schedule.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name: string;
+    /**
+     * Metadata tags that have been applied to the schedule.
+     */
+    Tags?: Tag[] | undefined;
+};
+//# sourceMappingURL=aws-databrew-schedule.d.ts.map