UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

973 lines 2.61 MB
import * as cdk from "../../core"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; /** * Creates an analysis in Amazon QuickSight. * * @cloudformationResource AWS::QuickSight::Analysis * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html */ export declare class CfnAnalysis 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 CfnAnalysis 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): CfnAnalysis; /** * The Amazon Resource Name (ARN) of the analysis. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * The time that the analysis was created. * * @cloudformationAttribute CreatedTime */ readonly attrCreatedTime: string; /** * @cloudformationAttribute DataSetArns */ readonly attrDataSetArns: Array<string>; /** * @cloudformationAttribute Errors */ readonly attrErrors: cdk.IResolvable; /** * The time that the analysis was last updated. * * @cloudformationAttribute LastUpdatedTime */ readonly attrLastUpdatedTime: string; /** * @cloudformationAttribute Sheets */ readonly attrSheets: cdk.IResolvable; /** * The ID for the analysis that you're creating. */ analysisId: string; /** * The ID of the AWS account where you are creating an analysis. */ awsAccountId: string; definition?: CfnAnalysis.AnalysisDefinitionProperty | cdk.IResolvable; /** * Errors associated with the analysis. */ errors?: Array<CfnAnalysis.AnalysisErrorProperty | cdk.IResolvable> | cdk.IResolvable; /** * A descriptive name for the analysis that you're creating. */ name: string; /** * The parameter names and override values that you want to use. */ parameters?: cdk.IResolvable | CfnAnalysis.ParametersProperty; /** * A structure that describes the principals and the resource-level permissions on an analysis. */ permissions?: Array<cdk.IResolvable | CfnAnalysis.ResourcePermissionProperty> | cdk.IResolvable; /** * A list of the associated sheets with the unique identifier and name of each sheet. */ sheets?: Array<cdk.IResolvable | CfnAnalysis.SheetProperty> | cdk.IResolvable; /** * A source entity to use for the analysis that you're creating. */ sourceEntity?: CfnAnalysis.AnalysisSourceEntityProperty | cdk.IResolvable; /** * Status associated with the analysis. */ status?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis. */ tagsRaw?: Array<cdk.CfnTag>; /** * The ARN for the theme to apply to the analysis that you're creating. */ themeArn?: string; /** * The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. */ validationStrategy?: cdk.IResolvable | CfnAnalysis.ValidationStrategyProperty; /** * @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: CfnAnalysisProps); 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 CfnAnalysis { /** * A list of Amazon QuickSight parameters and the list's override values. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html */ interface ParametersProperty { /** * The parameters that have a data type of date-time. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-datetimeparameters */ readonly dateTimeParameters?: Array<CfnAnalysis.DateTimeParameterProperty | cdk.IResolvable> | cdk.IResolvable; /** * The parameters that have a data type of decimal. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-decimalparameters */ readonly decimalParameters?: Array<CfnAnalysis.DecimalParameterProperty | cdk.IResolvable> | cdk.IResolvable; /** * The parameters that have a data type of integer. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-integerparameters */ readonly integerParameters?: Array<CfnAnalysis.IntegerParameterProperty | cdk.IResolvable> | cdk.IResolvable; /** * The parameters that have a data type of string. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-parameters.html#cfn-quicksight-analysis-parameters-stringparameters */ readonly stringParameters?: Array<cdk.IResolvable | CfnAnalysis.StringParameterProperty> | cdk.IResolvable; } /** * A string parameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html */ interface StringParameterProperty { /** * A display name for a string parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html#cfn-quicksight-analysis-stringparameter-name */ readonly name: string; /** * The values of a string parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-stringparameter.html#cfn-quicksight-analysis-stringparameter-values */ readonly values: Array<string>; } /** * A decimal parameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html */ interface DecimalParameterProperty { /** * A display name for the decimal parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html#cfn-quicksight-analysis-decimalparameter-name */ readonly name: string; /** * The values for the decimal parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-decimalparameter.html#cfn-quicksight-analysis-decimalparameter-values */ readonly values: Array<number> | cdk.IResolvable; } /** * An integer parameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html */ interface IntegerParameterProperty { /** * The name of the integer parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html#cfn-quicksight-analysis-integerparameter-name */ readonly name: string; /** * The values for the integer parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-integerparameter.html#cfn-quicksight-analysis-integerparameter-values */ readonly values: Array<number> | cdk.IResolvable; } /** * A date-time parameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html */ interface DateTimeParameterProperty { /** * A display name for the date-time parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html#cfn-quicksight-analysis-datetimeparameter-name */ readonly name: string; /** * The values for the date-time parameter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datetimeparameter.html#cfn-quicksight-analysis-datetimeparameter-values */ readonly values: Array<string>; } /** * The source entity of an analysis. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html */ interface AnalysisSourceEntityProperty { /** * The source template for the source entity of the analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourceentity.html#cfn-quicksight-analysis-analysissourceentity-sourcetemplate */ readonly sourceTemplate?: CfnAnalysis.AnalysisSourceTemplateProperty | cdk.IResolvable; } /** * The source template of an analysis. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html */ interface AnalysisSourceTemplateProperty { /** * The Amazon Resource Name (ARN) of the source template of an analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-arn */ readonly arn: string; /** * The dataset references of the source template of an analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysissourcetemplate.html#cfn-quicksight-analysis-analysissourcetemplate-datasetreferences */ readonly dataSetReferences: Array<CfnAnalysis.DataSetReferenceProperty | cdk.IResolvable> | cdk.IResolvable; } /** * Dataset reference. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html */ interface DataSetReferenceProperty { /** * Dataset Amazon Resource Name (ARN). * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetarn */ readonly dataSetArn: string; /** * Dataset placeholder. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-datasetreference.html#cfn-quicksight-analysis-datasetreference-datasetplaceholder */ readonly dataSetPlaceholder: string; } /** * The definition of an analysis. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html */ interface AnalysisDefinitionProperty { /** * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-analysisdefaults */ readonly analysisDefaults?: CfnAnalysis.AnalysisDefaultsProperty | cdk.IResolvable; /** * An array of calculated field definitions for the analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-calculatedfields */ readonly calculatedFields?: Array<CfnAnalysis.CalculatedFieldProperty | cdk.IResolvable> | cdk.IResolvable; /** * An array of analysis-level column configurations. * * Column configurations can be used to set default formatting for a column to be used throughout an analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-columnconfigurations */ readonly columnConfigurations?: Array<CfnAnalysis.ColumnConfigurationProperty | cdk.IResolvable> | cdk.IResolvable; /** * An array of dataset identifier declarations. * * This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-datasetidentifierdeclarations */ readonly dataSetIdentifierDeclarations: Array<CfnAnalysis.DataSetIdentifierDeclarationProperty | cdk.IResolvable> | cdk.IResolvable; /** * Filter definitions for an analysis. * * For more information, see [Filtering Data in Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html) in the *Amazon QuickSight User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-filtergroups */ readonly filterGroups?: Array<CfnAnalysis.FilterGroupProperty | cdk.IResolvable> | cdk.IResolvable; /** * An array of option definitions for an analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-options */ readonly options?: CfnAnalysis.AssetOptionsProperty | cdk.IResolvable; /** * An array of parameter declarations for an analysis. * * Parameters are named variables that can transfer a value for use by an action or an object. * * For more information, see [Parameters in Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html) in the *Amazon QuickSight User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-parameterdeclarations */ readonly parameterDeclarations?: Array<cdk.IResolvable | CfnAnalysis.ParameterDeclarationProperty> | cdk.IResolvable; /** * An array of sheet definitions for an analysis. * * Each `SheetDefinition` provides detailed information about a sheet within this analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-analysisdefinition.html#cfn-quicksight-analysis-analysisdefinition-sheets */ readonly sheets?: Array<cdk.IResolvable | CfnAnalysis.SheetDefinitionProperty> | cdk.IResolvable; } /** * A grouping of individual filters. Filter groups are applied to the same group of visuals. * * For more information, see [Adding filter conditions (group filters) with AND and OR operators](https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html) in the *Amazon QuickSight User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html */ interface FilterGroupProperty { /** * The filter new feature which can apply filter group to all data sets. Choose one of the following options:. * * - `ALL_DATASETS` * - `SINGLE_DATASET` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-crossdataset */ readonly crossDataset: string; /** * The value that uniquely identifies a `FilterGroup` within a dashboard, template, or analysis. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-filtergroupid */ readonly filterGroupId: string; /** * The list of filters that are present in a `FilterGroup` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-filters */ readonly filters: Array<CfnAnalysis.FilterProperty | cdk.IResolvable> | cdk.IResolvable; /** * The configuration that specifies what scope to apply to a `FilterGroup` . * * This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-scopeconfiguration */ readonly scopeConfiguration: CfnAnalysis.FilterScopeConfigurationProperty | cdk.IResolvable; /** * The status of the `FilterGroup` . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filtergroup.html#cfn-quicksight-analysis-filtergroup-status */ readonly status?: string; } /** * With a `Filter` , you can remove portions of data from a particular visual or view. * * This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html */ interface FilterProperty { /** * A `CategoryFilter` filters text values. * * For more information, see [Adding text filters](https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html) in the *Amazon QuickSight User Guide* . * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-categoryfilter */ readonly categoryFilter?: CfnAnalysis.CategoryFilterProperty | cdk.IResolvable; /** * A `NumericEqualityFilter` filters numeric values that equal or do not equal a given numeric value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-numericequalityfilter */ readonly numericEqualityFilter?: cdk.IResolvable | CfnAnalysis.NumericEqualityFilterProperty; /** * A `NumericRangeFilter` filters numeric values that are either inside or outside a given numeric range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-numericrangefilter */ readonly numericRangeFilter?: cdk.IResolvable | CfnAnalysis.NumericRangeFilterProperty; /** * A `RelativeDatesFilter` filters date values that are relative to a given date. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-relativedatesfilter */ readonly relativeDatesFilter?: cdk.IResolvable | CfnAnalysis.RelativeDatesFilterProperty; /** * A `TimeEqualityFilter` filters date-time values that equal or do not equal a given date/time value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-timeequalityfilter */ readonly timeEqualityFilter?: cdk.IResolvable | CfnAnalysis.TimeEqualityFilterProperty; /** * A `TimeRangeFilter` filters date-time values that are either inside or outside a given date/time range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-timerangefilter */ readonly timeRangeFilter?: cdk.IResolvable | CfnAnalysis.TimeRangeFilterProperty; /** * A `TopBottomFilter` filters data to the top or bottom values for a given column. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-filter.html#cfn-quicksight-analysis-filter-topbottomfilter */ readonly topBottomFilter?: cdk.IResolvable | CfnAnalysis.TopBottomFilterProperty; } /** * A `NumericEqualityFilter` filters values that are equal to the specified value. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html */ interface NumericEqualityFilterProperty { /** * The aggregation function of the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-aggregationfunction */ readonly aggregationFunction?: CfnAnalysis.AggregationFunctionProperty | cdk.IResolvable; /** * The column that the filter is applied to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-column */ readonly column: CfnAnalysis.ColumnIdentifierProperty | cdk.IResolvable; /** * An identifier that uniquely identifies a filter within a dashboard, analysis, or template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-filterid */ readonly filterId: string; /** * The match operator that is used to determine if a filter should be applied. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-matchoperator */ readonly matchOperator: string; /** * This option determines how null values should be treated when filtering data. * * - `ALL_VALUES` : Include null values in filtered results. * - `NULLS_ONLY` : Only include null values in filtered results. * - `NON_NULLS_ONLY` : Exclude null values from filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-nulloption */ readonly nullOption: string; /** * The parameter whose value should be used for the filter value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-parametername */ readonly parameterName?: string; /** * Select all of the values. Null is not the assigned value of select all. * * - `FILTER_ALL_VALUES` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-selectalloptions */ readonly selectAllOptions?: string; /** * The input value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericequalityfilter.html#cfn-quicksight-analysis-numericequalityfilter-value */ readonly value?: number; } /** * An aggregation function aggregates values from a dimension or measure. * * This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html */ interface AggregationFunctionProperty { /** * Aggregation for attributes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-attributeaggregationfunction */ readonly attributeAggregationFunction?: CfnAnalysis.AttributeAggregationFunctionProperty | cdk.IResolvable; /** * Aggregation for categorical values. * * - `COUNT` : Aggregate by the total number of values, including duplicates. * - `DISTINCT_COUNT` : Aggregate by the total number of distinct values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-categoricalaggregationfunction */ readonly categoricalAggregationFunction?: string; /** * Aggregation for date values. * * - `COUNT` : Aggregate by the total number of values, including duplicates. * - `DISTINCT_COUNT` : Aggregate by the total number of distinct values. * - `MIN` : Select the smallest date value. * - `MAX` : Select the largest date value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-dateaggregationfunction */ readonly dateAggregationFunction?: string; /** * Aggregation for numerical values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-aggregationfunction.html#cfn-quicksight-analysis-aggregationfunction-numericalaggregationfunction */ readonly numericalAggregationFunction?: cdk.IResolvable | CfnAnalysis.NumericalAggregationFunctionProperty; } /** * Aggregation for attributes. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html */ interface AttributeAggregationFunctionProperty { /** * The built-in aggregation functions for attributes. * * - `UNIQUE_VALUE` : Returns the unique value for a field, aggregated by the dimension fields. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html#cfn-quicksight-analysis-attributeaggregationfunction-simpleattributeaggregation */ readonly simpleAttributeAggregation?: string; /** * Used by the `UNIQUE_VALUE` aggregation function. * * If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-attributeaggregationfunction.html#cfn-quicksight-analysis-attributeaggregationfunction-valueformultiplevalues */ readonly valueForMultipleValues?: string; } /** * Aggregation for numerical values. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html */ interface NumericalAggregationFunctionProperty { /** * An aggregation based on the percentile of values in a dimension or measure. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html#cfn-quicksight-analysis-numericalaggregationfunction-percentileaggregation */ readonly percentileAggregation?: cdk.IResolvable | CfnAnalysis.PercentileAggregationProperty; /** * Built-in aggregation functions for numerical values. * * - `SUM` : The sum of a dimension or measure. * - `AVERAGE` : The average of a dimension or measure. * - `MIN` : The minimum value of a dimension or measure. * - `MAX` : The maximum value of a dimension or measure. * - `COUNT` : The count of a dimension or measure. * - `DISTINCT_COUNT` : The count of distinct values in a dimension or measure. * - `VAR` : The variance of a dimension or measure. * - `VARP` : The partitioned variance of a dimension or measure. * - `STDEV` : The standard deviation of a dimension or measure. * - `STDEVP` : The partitioned standard deviation of a dimension or measure. * - `MEDIAN` : The median value of a dimension or measure. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericalaggregationfunction.html#cfn-quicksight-analysis-numericalaggregationfunction-simplenumericalaggregation */ readonly simpleNumericalAggregation?: string; } /** * An aggregation based on the percentile of values in a dimension or measure. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentileaggregation.html */ interface PercentileAggregationProperty { /** * The percentile value. * * This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-percentileaggregation.html#cfn-quicksight-analysis-percentileaggregation-percentilevalue */ readonly percentileValue?: number; } /** * A column of a data set. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html */ interface ColumnIdentifierProperty { /** * The name of the column. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html#cfn-quicksight-analysis-columnidentifier-columnname */ readonly columnName: string; /** * The data set that the column belongs to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-columnidentifier.html#cfn-quicksight-analysis-columnidentifier-datasetidentifier */ readonly dataSetIdentifier: string; } /** * A `NumericRangeFilter` filters values that are within the value range. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html */ interface NumericRangeFilterProperty { /** * The aggregation function of the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-aggregationfunction */ readonly aggregationFunction?: CfnAnalysis.AggregationFunctionProperty | cdk.IResolvable; /** * The column that the filter is applied to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-column */ readonly column: CfnAnalysis.ColumnIdentifierProperty | cdk.IResolvable; /** * An identifier that uniquely identifies a filter within a dashboard, analysis, or template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-filterid */ readonly filterId: string; /** * Determines whether the maximum value in the filter value range should be included in the filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includemaximum */ readonly includeMaximum?: boolean | cdk.IResolvable; /** * Determines whether the minimum value in the filter value range should be included in the filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-includeminimum */ readonly includeMinimum?: boolean | cdk.IResolvable; /** * This option determines how null values should be treated when filtering data. * * - `ALL_VALUES` : Include null values in filtered results. * - `NULLS_ONLY` : Only include null values in filtered results. * - `NON_NULLS_ONLY` : Exclude null values from filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-nulloption */ readonly nullOption: string; /** * The maximum value for the filter value range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangemaximum */ readonly rangeMaximum?: cdk.IResolvable | CfnAnalysis.NumericRangeFilterValueProperty; /** * The minimum value for the filter value range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-rangeminimum */ readonly rangeMinimum?: cdk.IResolvable | CfnAnalysis.NumericRangeFilterValueProperty; /** * Select all of the values. Null is not the assigned value of select all. * * - `FILTER_ALL_VALUES` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefilter.html#cfn-quicksight-analysis-numericrangefilter-selectalloptions */ readonly selectAllOptions?: string; } /** * The value input pf the numeric range filter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html */ interface NumericRangeFilterValueProperty { /** * The parameter that is used in the numeric range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html#cfn-quicksight-analysis-numericrangefiltervalue-parameter */ readonly parameter?: string; /** * The static value of the numeric range filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-numericrangefiltervalue.html#cfn-quicksight-analysis-numericrangefiltervalue-staticvalue */ readonly staticValue?: number; } /** * A `TimeRangeFilter` filters values that are between two specified values. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html */ interface TimeRangeFilterProperty { /** * The column that the filter is applied to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-column */ readonly column: CfnAnalysis.ColumnIdentifierProperty | cdk.IResolvable; /** * The exclude period of the time range filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-excludeperiodconfiguration */ readonly excludePeriodConfiguration?: CfnAnalysis.ExcludePeriodConfigurationProperty | cdk.IResolvable; /** * An identifier that uniquely identifies a filter within a dashboard, analysis, or template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-filterid */ readonly filterId: string; /** * Determines whether the maximum value in the filter value range should be included in the filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-includemaximum */ readonly includeMaximum?: boolean | cdk.IResolvable; /** * Determines whether the minimum value in the filter value range should be included in the filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-includeminimum */ readonly includeMinimum?: boolean | cdk.IResolvable; /** * This option determines how null values should be treated when filtering data. * * - `ALL_VALUES` : Include null values in filtered results. * - `NULLS_ONLY` : Only include null values in filtered results. * - `NON_NULLS_ONLY` : Exclude null values from filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-nulloption */ readonly nullOption: string; /** * The maximum value for the filter value range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-rangemaximumvalue */ readonly rangeMaximumValue?: cdk.IResolvable | CfnAnalysis.TimeRangeFilterValueProperty; /** * The minimum value for the filter value range. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-rangeminimumvalue */ readonly rangeMinimumValue?: cdk.IResolvable | CfnAnalysis.TimeRangeFilterValueProperty; /** * The level of time precision that is used to aggregate `DateTime` values. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefilter.html#cfn-quicksight-analysis-timerangefilter-timegranularity */ readonly timeGranularity?: string; } /** * The value of a time range filter. * * This is a union type structure. For this structure to be valid, only one of the attributes can be defined. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html */ interface TimeRangeFilterValueProperty { /** * The parameter type input value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-parameter */ readonly parameter?: string; /** * The rolling date input value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-rollingdate */ readonly rollingDate?: cdk.IResolvable | CfnAnalysis.RollingDateConfigurationProperty; /** * The static input value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-timerangefiltervalue.html#cfn-quicksight-analysis-timerangefiltervalue-staticvalue */ readonly staticValue?: string; } /** * The rolling date configuration of a date time filter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html */ interface RollingDateConfigurationProperty { /** * The data set that is used in the rolling date configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html#cfn-quicksight-analysis-rollingdateconfiguration-datasetidentifier */ readonly dataSetIdentifier?: string; /** * The expression of the rolling date configuration. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-rollingdateconfiguration.html#cfn-quicksight-analysis-rollingdateconfiguration-expression */ readonly expression: string; } /** * The exclude period of `TimeRangeFilter` or `RelativeDatesFilter` . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html */ interface ExcludePeriodConfigurationProperty { /** * The amount or number of the exclude period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-amount */ readonly amount: number; /** * The granularity or unit (day, month, year) of the exclude period. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-granularity */ readonly granularity: string; /** * The status of the exclude period. Choose from the following options:. * * - `ENABLED` * - `DISABLED` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-excludeperiodconfiguration.html#cfn-quicksight-analysis-excludeperiodconfiguration-status */ readonly status?: string; } /** * A `RelativeDatesFilter` filters relative dates values. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html */ interface RelativeDatesFilterProperty { /** * The date configuration of the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration */ readonly anchorDateConfiguration: CfnAnalysis.AnchorDateConfigurationProperty | cdk.IResolvable; /** * The column that the filter is applied to. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-column */ readonly column: CfnAnalysis.ColumnIdentifierProperty | cdk.IResolvable; /** * The configuration for the exclude period of the filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-excludeperiodconfiguration */ readonly excludePeriodConfiguration?: CfnAnalysis.ExcludePeriodConfigurationProperty | cdk.IResolvable; /** * An identifier that uniquely identifies a filter within a dashboard, analysis, or template. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-filterid */ readonly filterId: string; /** * The minimum granularity (period granularity) of the relative dates filter. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-minimumgranularity */ readonly minimumGranularity?: string; /** * This option determines how null values should be treated when filtering data. * * - `ALL_VALUES` : Include null values in filtered results. * - `NULLS_ONLY` : Only include null values in filtered results. * - `NON_NULLS_ONLY` : Exclude null values from filtered results. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-nulloption */ readonly nullOption: string; /** * The parameter whose value should be used for the filter value. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-parametername */ readonly parameterName?: string; /** * The range date type of the filter. Choose one of the options below:. * * - `PREVIOUS` * - `THIS` * - `LAST` * - `NOW` * - `NEXT` * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-relativedatesfilter.html#cfn-quicksight-analysis-relativedatesfilter-relativedatetype */ readonly relativeDateType: string; /** * The date va