@horietakehiro/aws-cdk-utul 0.41.43 → 0.41.46

package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts

@@ -14,8 +14,14 @@ export type DatasetParameterValueType = ("MULTI_VALUED" | "SINGLE_VALUED");
 export type TimeGranularity = ("YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "MINUTE" | "SECOND" | "MILLISECOND");
 export type GeoSpatialDataRole = ("COUNTRY" | "STATE" | "COUNTY" | "CITY" | "POSTCODE" | "LONGITUDE" | "LATITUDE" | "POLITICAL1" | "CENSUS_TRACT" | "CENSUS_BLOCK_GROUP" | "CENSUS_BLOCK");
 export type ColumnTagName = ("COLUMN_GEOGRAPHIC_ROLE" | "COLUMN_DESCRIPTION");
+export type DataSetDateComparisonFilterOperator = ("BEFORE" | "BEFORE_OR_EQUALS_TO" | "AFTER" | "AFTER_OR_EQUALS_TO");
+export type DataSetStringComparisonFilterOperator = ("EQUALS" | "DOES_NOT_EQUAL" | "CONTAINS" | "DOES_NOT_CONTAIN" | "STARTS_WITH" | "ENDS_WITH");
+export type DataSetStringListFilterOperator = ("INCLUDE" | "EXCLUDE");
+export type DataSetNumericComparisonFilterOperator = ("EQUALS" | "DOES_NOT_EQUAL" | "GREATER_THAN" | "GREATER_THAN_OR_EQUALS_TO" | "LESS_THAN" | "LESS_THAN_OR_EQUALS_TO");
 export type ColumnDataType = ("STRING" | "INTEGER" | "DECIMAL" | "DATETIME");
 export type JoinType = ("INNER" | "OUTER" | "LEFT" | "RIGHT");
+export type JoinOperationType = ("INNER" | "OUTER" | "LEFT" | "RIGHT");
+export type DataPrepSimpleAggregationFunctionType = ("COUNT" | "DISTINCT_COUNT" | "SUM" | "AVERAGE" | "MEDIAN" | "MAX" | "MIN" | "VARIANCE" | "STANDARD_DEVIATION");
 /**
  * Definition of the AWS::QuickSight::DataSet Resource Type.
  */
@@ -71,6 +77,7 @@ export interface _AWS_QUICKSIGHT_DATASET {
      * <p>The last time that this dataset was updated.</p>
      */
     LastUpdatedTime?: string;
+    SemanticModelConfiguration?: SemanticModelConfiguration;
     DataSetId?: string;
     PerformanceConfiguration?: PerformanceConfiguration;
     DataSetRefreshProperties?: DataSetRefreshProperties;
@@ -98,6 +105,7 @@ export interface _AWS_QUICKSIGHT_DATASET {
      *             analyses, and dashboards.</p>
      */
     OutputColumns?: OutputColumn[];
+    DataPrepConfiguration?: DataPrepConfiguration;
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
      */
@@ -218,10 +226,40 @@ export interface PhysicalTableMap {
  * via the `patternProperty` "^[0-9a-zA-Z-]*$".
  */
 export interface PhysicalTable {
+    SaaSTable?: SaaSTable;
     RelationalTable?: RelationalTable;
     CustomSql?: CustomSql;
     S3Source?: S3Source;
 }
+export interface SaaSTable {
+    DataSourceArn: string;
+    /**
+     * @minItems 0
+     * @maxItems 2048
+     */
+    InputColumns: InputColumn[];
+    /**
+     * @minItems 1
+     * @maxItems 32
+     */
+    TablePath: TablePathElement[];
+}
+/**
+ * <p>Metadata for a column that is used as the input of a transform operation.</p>
+ */
+export interface InputColumn {
+    Type: InputColumnDataType;
+    SubType?: ColumnDataSubType;
+    Id?: string;
+    /**
+     * <p>The name of this column in the underlying data source.</p>
+     */
+    Name: string;
+}
+export interface TablePathElement {
+    Id?: string;
+    Name?: string;
+}
 /**
  * <p>A physical table type for relational data sources.</p>
  */
@@ -236,7 +274,7 @@ export interface RelationalTable {
      * @minItems 0
      * @maxItems 2048
      */
-    InputColumns?: InputColumn[];
+    InputColumns: InputColumn[];
     /**
      * <p>The schema name. This name applies to certain relational database engines.</p>
      */
@@ -250,17 +288,6 @@ export interface RelationalTable {
      */
     Name: string;
 }
-/**
- * <p>Metadata for a column that is used as the input of a transform operation.</p>
- */
-export interface InputColumn {
-    Type: InputColumnDataType;
-    SubType?: ColumnDataSubType;
-    /**
-     * <p>The name of this column in the underlying data source.</p>
-     */
-    Name: string;
-}
 /**
  * <p>A physical table type built from the results of the custom SQL query.</p>
  */
@@ -279,7 +306,7 @@ export interface CustomSql {
      * @minItems 0
      * @maxItems 2048
      */
-    Columns?: InputColumn[];
+    Columns: InputColumn[];
     /**
      * <p>A display name for the SQL query result.</p>
      */
@@ -302,7 +329,7 @@ export interface S3Source {
      * @minItems 0
      * @maxItems 2048
      */
-    InputColumns?: InputColumn[];
+    InputColumns: InputColumn[];
     UploadSettings?: UploadSettings;
 }
 /**
@@ -346,6 +373,66 @@ export interface FieldFolder {
      */
     Columns?: string[];
 }
+export interface SemanticModelConfiguration {
+    TableMap?: SemanticTableMap;
+}
+export interface SemanticTableMap {
+    [k: string]: SemanticTable;
+}
+/**
+ * This interface was referenced by `SemanticTableMap`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9a-zA-Z-]*$".
+ */
+export interface SemanticTable {
+    Alias: string;
+    DestinationTableId: string;
+    RowLevelPermissionConfiguration?: RowLevelPermissionConfiguration;
+}
+export interface RowLevelPermissionConfiguration {
+    TagConfiguration?: RowLevelPermissionTagConfiguration;
+    RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
+}
+/**
+ * <p>The configuration of tags on a dataset to set row-level security. </p>
+ */
+export interface RowLevelPermissionTagConfiguration {
+    Status?: Status;
+    /**
+     * <p>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</p>
+     *
+     * @minItems 1
+     * @maxItems 50
+     */
+    TagRules: RowLevelPermissionTagRule[];
+    /**
+     * <p>A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.</p>
+     *
+     * @minItems 1
+     * @maxItems 50
+     */
+    TagRuleConfigurations?: string[][];
+}
+/**
+ * <p>A set of rules associated with a tag.</p>
+ */
+export interface RowLevelPermissionTagRule {
+    /**
+     * <p>The column name that a tag key is assigned to.</p>
+     */
+    ColumnName: string;
+    /**
+     * <p>The unique key for a tag.</p>
+     */
+    TagKey: string;
+    /**
+     * <p>A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.</p>
+     */
+    MatchAllValue?: string;
+    /**
+     * <p>A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.</p>
+     */
+    TagMultiValueDelimiter?: string;
+}
 export interface PerformanceConfiguration {
     /**
      * @minItems 1
@@ -358,7 +445,7 @@ export interface UniqueKey {
      * @minItems 1
      * @maxItems 1
      */
-    ColumnNames?: string[];
+    ColumnNames: string[];
 }
 /**
  * <p>The refresh properties of a dataset.</p>
@@ -399,47 +486,6 @@ export interface RefreshFailureConfiguration {
 export interface RefreshFailureEmailAlert {
     AlertStatus?: RefreshFailureAlertStatus;
 }
-/**
- * <p>The configuration of tags on a dataset to set row-level security. </p>
- */
-export interface RowLevelPermissionTagConfiguration {
-    Status?: Status;
-    /**
-     * <p>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</p>
-     *
-     * @minItems 1
-     * @maxItems 50
-     */
-    TagRules: RowLevelPermissionTagRule[];
-    /**
-     * <p>A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.</p>
-     *
-     * @minItems 1
-     * @maxItems 50
-     */
-    TagRuleConfigurations?: string[][];
-}
-/**
- * <p>A set of rules associated with a tag.</p>
- */
-export interface RowLevelPermissionTagRule {
-    /**
-     * <p>The column name that a tag key is assigned to.</p>
-     */
-    ColumnName?: string;
-    /**
-     * <p>The unique key for a tag.</p>
-     */
-    TagKey: string;
-    /**
-     * <p>A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.</p>
-     */
-    MatchAllValue?: string;
-    /**
-     * <p>A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.</p>
-     */
-    TagMultiValueDelimiter?: string;
-}
 /**
  * <p>Groupings of columns that work together in certain Amazon QuickSight features. This is
  *             a variant type structure. For this structure to be valid, only one of the attributes can
@@ -607,7 +653,7 @@ export interface LogicalTable {
      * @maxItems 2048
      */
     DataTransforms?: TransformOperation[];
-    Source?: LogicalTableSource;
+    Source: LogicalTableSource;
 }
 /**
  * <p>A data transformation on a logical table. This is a variant type structure. For this
@@ -615,12 +661,12 @@ export interface LogicalTable {
  */
 export interface TransformOperation {
     TagColumnOperation?: TagColumnOperation;
-    RenameColumnOperation?: RenameColumnOperation;
     UntagColumnOperation?: UntagColumnOperation;
     OverrideDatasetParameterOperation?: OverrideDatasetParameterOperation;
     FilterOperation?: FilterOperation;
     CastColumnTypeOperation?: CastColumnTypeOperation;
     CreateColumnsOperation?: CreateColumnsOperation;
+    RenameColumnOperation?: RenameColumnOperation;
     ProjectOperation?: ProjectOperation;
 }
 /**
@@ -664,19 +710,6 @@ export interface ColumnDescription {
      */
     Text?: string;
 }
-/**
- * <p>A transform operation that renames a column.</p>
- */
-export interface RenameColumnOperation {
-    /**
-     * <p>The new name for the column.</p>
-     */
-    NewColumnName?: string;
-    /**
-     * <p>The name of the column to be renamed.</p>
-     */
-    ColumnName?: string;
-}
 /**
  * <p>A transform operation that removes tags associated with a column.</p>
  */
@@ -741,11 +774,73 @@ export interface NewDefaultValues {
  * <p>A transform operation that filters rows based on a condition.</p>
  */
 export interface FilterOperation {
+    DateFilterCondition?: DataSetDateFilterCondition;
+    StringFilterCondition?: DataSetStringFilterCondition;
     /**
      * <p>An expression that must evaluate to a Boolean value. Rows for which the expression
      *             evaluates to true are kept in the dataset.</p>
      */
     ConditionExpression?: string;
+    NumericFilterCondition?: DataSetNumericFilterCondition;
+}
+export interface DataSetDateFilterCondition {
+    ColumnName?: string;
+    RangeFilterCondition?: DataSetDateRangeFilterCondition;
+    ComparisonFilterCondition?: DataSetDateComparisonFilterCondition;
+}
+export interface DataSetDateRangeFilterCondition {
+    IncludeMaximum?: boolean;
+    RangeMinimum?: DataSetDateFilterValue;
+    RangeMaximum?: DataSetDateFilterValue;
+    IncludeMinimum?: boolean;
+}
+export interface DataSetDateFilterValue {
+    StaticValue?: string;
+}
+export interface DataSetDateComparisonFilterCondition {
+    Operator: DataSetDateComparisonFilterOperator;
+    Value?: DataSetDateFilterValue;
+}
+export interface DataSetStringFilterCondition {
+    ColumnName?: string;
+    ComparisonFilterCondition?: DataSetStringComparisonFilterCondition;
+    ListFilterCondition?: DataSetStringListFilterCondition;
+}
+export interface DataSetStringComparisonFilterCondition {
+    Operator: DataSetStringComparisonFilterOperator;
+    Value?: DataSetStringFilterValue;
+}
+export interface DataSetStringFilterValue {
+    StaticValue?: string;
+}
+export interface DataSetStringListFilterCondition {
+    Operator: DataSetStringListFilterOperator;
+    Values?: DataSetStringListFilterValue;
+}
+export interface DataSetStringListFilterValue {
+    /**
+     * @minItems 0
+     * @maxItems 1000
+     */
+    StaticValues?: string[];
+}
+export interface DataSetNumericFilterCondition {
+    ColumnName?: string;
+    RangeFilterCondition?: DataSetNumericRangeFilterCondition;
+    ComparisonFilterCondition?: DataSetNumericComparisonFilterCondition;
+}
+export interface DataSetNumericRangeFilterCondition {
+    IncludeMaximum?: boolean;
+    RangeMinimum?: DataSetNumericFilterValue;
+    RangeMaximum?: DataSetNumericFilterValue;
+    IncludeMinimum?: boolean;
+}
+export interface DataSetNumericFilterValue {
+    StaticValue?: number;
+}
+export interface DataSetNumericComparisonFilterCondition {
+    Operator: DataSetNumericComparisonFilterOperator;
+    Value?: DataSetNumericFilterValue;
 }
 /**
  * <p>A transform operation that casts a column to a different type.</p>
@@ -754,7 +849,7 @@ export interface CastColumnTypeOperation {
     /**
      * <p>Column name.</p>
      */
-    ColumnName?: string;
+    ColumnName: string;
     SubType?: ColumnDataSubType;
     /**
      * <p>When casting a column from string to datetime type, you can supply a string in a
@@ -768,13 +863,15 @@ export interface CastColumnTypeOperation {
  *             operation form a lexical closure.</p>
  */
 export interface CreateColumnsOperation {
+    Alias?: string;
     /**
      * <p>Calculated columns to create.</p>
      *
      * @minItems 0
      * @maxItems 256
      */
-    Columns?: CalculatedColumn[];
+    Columns: CalculatedColumn[];
+    Source?: TransformOperationSource;
 }
 /**
  * <p>A calculated column for a dataset.</p>
@@ -795,18 +892,45 @@ export interface CalculatedColumn {
      */
     Expression: string;
 }
+export interface TransformOperationSource {
+    TransformOperationId: string;
+    /**
+     * @minItems 1
+     * @maxItems 2048
+     */
+    ColumnIdMappings?: DataSetColumnIdMapping[];
+}
+export interface DataSetColumnIdMapping {
+    SourceColumnId: string;
+    TargetColumnId: string;
+}
+/**
+ * <p>A transform operation that renames a column.</p>
+ */
+export interface RenameColumnOperation {
+    /**
+     * <p>The new name for the column.</p>
+     */
+    NewColumnName: string;
+    /**
+     * <p>The name of the column to be renamed.</p>
+     */
+    ColumnName: string;
+}
 /**
  * <p>A transform operation that projects columns. Operations that come after a projection
  *             can only refer to projected columns.</p>
  */
 export interface ProjectOperation {
+    Alias?: string;
     /**
      * <p>Projected columns.</p>
      *
      * @minItems 0
-     * @maxItems 2000
+     * @maxItems 2048
      */
     ProjectedColumns?: string[];
+    Source?: TransformOperationSource;
 }
 /**
  * <p>Information about the source of a logical table. This is a variant type structure. For
@@ -876,8 +1000,221 @@ export interface OutputColumn {
      */
     Description?: string;
     SubType?: ColumnDataSubType;
+    Id?: string;
     /**
      * <p>The display name of the column..</p>
      */
     Name?: string;
 }
+export interface DataPrepConfiguration {
+    DestinationTableMap: DestinationTableMap;
+    TransformStepMap: TransformStepMap;
+    SourceTableMap: SourceTableMap;
+}
+export interface DestinationTableMap {
+    [k: string]: DestinationTable;
+}
+/**
+ * This interface was referenced by `DestinationTableMap`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9a-zA-Z-]*$".
+ */
+export interface DestinationTable {
+    Alias: string;
+    Source: DestinationTableSource;
+}
+export interface DestinationTableSource {
+    TransformOperationId: string;
+}
+export interface TransformStepMap {
+    [k: string]: TransformStep;
+}
+/**
+ * This interface was referenced by `TransformStepMap`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9a-zA-Z-]*$".
+ */
+export interface TransformStep {
+    ProjectStep?: ProjectOperation;
+    CreateColumnsStep?: CreateColumnsOperation;
+    RenameColumnsStep?: RenameColumnsOperation;
+    CastColumnTypesStep?: CastColumnTypesOperation;
+    ImportTableStep?: ImportTableOperation;
+    UnpivotStep?: UnpivotOperation;
+    JoinStep?: JoinOperation;
+    AppendStep?: AppendOperation;
+    FiltersStep?: FiltersOperation;
+    AggregateStep?: AggregateOperation;
+    PivotStep?: PivotOperation;
+}
+export interface RenameColumnsOperation {
+    Alias: string;
+    /**
+     * @minItems 0
+     * @maxItems 2048
+     */
+    RenameColumnOperations: RenameColumnOperation[];
+    Source: TransformOperationSource;
+}
+export interface CastColumnTypesOperation {
+    /**
+     * @minItems 0
+     * @maxItems 2048
+     */
+    CastColumnTypeOperations: CastColumnTypeOperation[];
+    Alias: string;
+    Source: TransformOperationSource;
+}
+export interface ImportTableOperation {
+    Alias: string;
+    Source: ImportTableOperationSource;
+}
+export interface ImportTableOperationSource {
+    SourceTableId: string;
+    /**
+     * @minItems 1
+     * @maxItems 2048
+     */
+    ColumnIdMappings?: DataSetColumnIdMapping[];
+}
+export interface UnpivotOperation {
+    UnpivotedLabelColumnName: string;
+    /**
+     * @minItems 0
+     * @maxItems 100
+     */
+    ColumnsToUnpivot: ColumnToUnpivot[];
+    UnpivotedLabelColumnId: string;
+    Alias: string;
+    UnpivotedValueColumnId: string;
+    UnpivotedValueColumnName: string;
+    Source: TransformOperationSource;
+}
+export interface ColumnToUnpivot {
+    ColumnName?: string;
+    NewValue?: string;
+}
+export interface JoinOperation {
+    OnClause: string;
+    Type: JoinOperationType;
+    RightOperandProperties?: JoinOperandProperties;
+    LeftOperandProperties?: JoinOperandProperties;
+    Alias: string;
+    LeftOperand: TransformOperationSource;
+    RightOperand: TransformOperationSource;
+}
+export interface JoinOperandProperties {
+    /**
+     * @minItems 1
+     * @maxItems 2048
+     */
+    OutputColumnNameOverrides: OutputColumnNameOverride[];
+}
+export interface OutputColumnNameOverride {
+    OutputColumnName: string;
+    SourceColumnName?: string;
+}
+export interface AppendOperation {
+    /**
+     * @minItems 0
+     * @maxItems 2048
+     */
+    AppendedColumns: AppendedColumn[];
+    SecondSource?: TransformOperationSource;
+    Alias: string;
+    FirstSource?: TransformOperationSource;
+}
+export interface AppendedColumn {
+    ColumnName: string;
+    NewColumnId: string;
+}
+export interface FiltersOperation {
+    /**
+     * @minItems 0
+     * @maxItems 128
+     */
+    FilterOperations: FilterOperation[];
+    Alias: string;
+    Source: TransformOperationSource;
+}
+export interface AggregateOperation {
+    /**
+     * @minItems 0
+     * @maxItems 128
+     */
+    GroupByColumnNames?: string[];
+    Alias: string;
+    /**
+     * @minItems 0
+     * @maxItems 128
+     */
+    Aggregations: Aggregation[];
+    Source: TransformOperationSource;
+}
+export interface Aggregation {
+    AggregationFunction: DataPrepAggregationFunction;
+    NewColumnName: string;
+    NewColumnId: string;
+}
+export interface DataPrepAggregationFunction {
+    PercentileAggregation?: DataPrepPercentileAggregationFunction;
+    SimpleAggregation?: DataPrepSimpleAggregationFunction;
+    ListAggregation?: DataPrepListAggregationFunction;
+}
+export interface DataPrepPercentileAggregationFunction {
+    InputColumnName?: string;
+    PercentileValue: number;
+}
+export interface DataPrepSimpleAggregationFunction {
+    FunctionType: DataPrepSimpleAggregationFunctionType;
+    InputColumnName?: string;
+}
+export interface DataPrepListAggregationFunction {
+    Distinct: boolean;
+    InputColumnName?: string;
+    Separator: string;
+}
+export interface PivotOperation {
+    PivotConfiguration: PivotConfiguration;
+    /**
+     * @minItems 0
+     * @maxItems 128
+     */
+    GroupByColumnNames?: string[];
+    Alias: string;
+    ValueColumnConfiguration: ValueColumnConfiguration;
+    Source: TransformOperationSource;
+}
+export interface PivotConfiguration {
+    LabelColumnName?: string;
+    /**
+     * @minItems 0
+     * @maxItems 100
+     */
+    PivotedLabels: PivotedLabel[];
+}
+export interface PivotedLabel {
+    NewColumnName: string;
+    NewColumnId: string;
+    LabelName: string;
+}
+export interface ValueColumnConfiguration {
+    AggregationFunction?: DataPrepAggregationFunction;
+}
+export interface SourceTableMap {
+    [k: string]: SourceTable;
+}
+/**
+ * This interface was referenced by `SourceTableMap`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9a-zA-Z-]*$".
+ */
+export interface SourceTable {
+    PhysicalTableId?: string;
+    DataSet?: ParentDataSet;
+}
+export interface ParentDataSet {
+    /**
+     * @minItems 0
+     * @maxItems 2048
+     */
+    InputColumns: InputColumn[];
+    DataSetArn: string;
+}