@awboost/cfn-resource-types 0.1.72 → 0.1.74
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/AWS-Bedrock-GuardrailVersion.d.ts +52 -0
- package/lib/AWS-Bedrock-GuardrailVersion.js +12 -0
- package/lib/AWS-Budgets-BudgetsAction.d.ts +9 -0
- package/lib/AWS-EC2-LaunchTemplate.d.ts +3 -3
- package/lib/AWS-EC2-LaunchTemplate.js +1 -1
- package/lib/AWS-KMS-Alias.d.ts +18 -2
- package/lib/AWS-KMS-Alias.js +9 -1
- package/lib/AWS-QuickSight-DataSet.d.ts +208 -137
- package/lib/AWS-QuickSight-DataSource.d.ts +89 -71
- package/lib/AWS-QuickSight-VPCConnection.d.ts +44 -2
- package/package.json +1 -1
|
@@ -12,27 +12,30 @@ export type QuickSightDataSetProperties = {
|
|
|
12
12
|
*/
|
|
13
13
|
AwsAccountId?: string;
|
|
14
14
|
/**
|
|
15
|
-
* <p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
15
|
+
* <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
|
|
16
16
|
* @minLength `1`
|
|
17
17
|
* @maxLength `8`
|
|
18
18
|
*/
|
|
19
19
|
ColumnGroups?: ColumnGroup[];
|
|
20
20
|
/**
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
* <p>A set of one or more definitions of a <code>
|
|
22
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
|
|
23
|
+
</code>.</p>
|
|
24
|
+
* @minLength `1`
|
|
25
|
+
*/
|
|
23
26
|
ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
|
|
24
27
|
DataSetId?: string;
|
|
25
28
|
/**
|
|
26
|
-
* <p>The
|
|
29
|
+
* <p>The refresh properties of a dataset.</p>
|
|
27
30
|
*/
|
|
28
31
|
DataSetRefreshProperties?: DataSetRefreshProperties;
|
|
29
32
|
/**
|
|
30
|
-
* <p>The
|
|
33
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
31
34
|
*/
|
|
32
35
|
DataSetUsageConfiguration?: DataSetUsageConfiguration;
|
|
33
36
|
/**
|
|
34
|
-
* <p>The
|
|
35
|
-
* @minLength `
|
|
37
|
+
* <p>The parameter declarations of the dataset.</p>
|
|
38
|
+
* @minLength `0`
|
|
36
39
|
* @maxLength `32`
|
|
37
40
|
*/
|
|
38
41
|
DatasetParameters?: DatasetParameter[];
|
|
@@ -57,11 +60,16 @@ export type QuickSightDataSetProperties = {
|
|
|
57
60
|
Permissions?: ResourcePermission[];
|
|
58
61
|
PhysicalTableMap?: PhysicalTableMap;
|
|
59
62
|
/**
|
|
60
|
-
|
|
61
|
-
|
|
63
|
+
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
64
|
+
The permissions dataset maps fields to users or groups. For more information, see
|
|
65
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User
|
|
66
|
+
Guide</i>.</p>
|
|
67
|
+
<p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
68
|
+
not supported for new RLS datasets.</p>
|
|
69
|
+
*/
|
|
62
70
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
|
|
63
71
|
/**
|
|
64
|
-
* <p>The configuration of tags on a dataset to set row-level security
|
|
72
|
+
* <p>The configuration of tags on a dataset to set row-level security. </p>
|
|
65
73
|
*/
|
|
66
74
|
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
|
|
67
75
|
/**
|
|
@@ -105,12 +113,12 @@ export type QuickSightDataSetAttributes = {
|
|
|
105
113
|
*/
|
|
106
114
|
Description: string;
|
|
107
115
|
/**
|
|
108
|
-
* <p>
|
|
116
|
+
* <p>The display name of the column..</p>
|
|
109
117
|
* @minLength `1`
|
|
110
|
-
* @maxLength `
|
|
118
|
+
* @maxLength `127`
|
|
111
119
|
*/
|
|
112
120
|
Name: string;
|
|
113
|
-
SubType:
|
|
121
|
+
SubType: ColumnDataSubType;
|
|
114
122
|
Type: ColumnDataType;
|
|
115
123
|
}[];
|
|
116
124
|
};
|
|
@@ -131,7 +139,7 @@ export type CalculatedColumn = {
|
|
|
131
139
|
/**
|
|
132
140
|
* <p>Column name.</p>
|
|
133
141
|
* @minLength `1`
|
|
134
|
-
* @maxLength `
|
|
142
|
+
* @maxLength `127`
|
|
135
143
|
*/
|
|
136
144
|
ColumnName: string;
|
|
137
145
|
/**
|
|
@@ -150,7 +158,7 @@ export type CastColumnTypeOperation = {
|
|
|
150
158
|
/**
|
|
151
159
|
* <p>Column name.</p>
|
|
152
160
|
* @minLength `1`
|
|
153
|
-
* @maxLength `
|
|
161
|
+
* @maxLength `127`
|
|
154
162
|
*/
|
|
155
163
|
ColumnName: string;
|
|
156
164
|
/**
|
|
@@ -161,8 +169,13 @@ export type CastColumnTypeOperation = {
|
|
|
161
169
|
*/
|
|
162
170
|
Format?: string;
|
|
163
171
|
NewColumnType: ColumnDataType;
|
|
164
|
-
SubType?:
|
|
172
|
+
SubType?: ColumnDataSubType;
|
|
165
173
|
};
|
|
174
|
+
/**
|
|
175
|
+
* Type definition for `AWS::QuickSight::DataSet.ColumnDataSubType`.
|
|
176
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columndatasubtype.html}
|
|
177
|
+
*/
|
|
178
|
+
export type ColumnDataSubType = "FLOAT" | "FIXED";
|
|
166
179
|
/**
|
|
167
180
|
* Type definition for `AWS::QuickSight::DataSet.ColumnDataType`.
|
|
168
181
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columndatatype.html}
|
|
@@ -196,27 +209,34 @@ export type ColumnGroup = {
|
|
|
196
209
|
};
|
|
197
210
|
/**
|
|
198
211
|
* Type definition for `AWS::QuickSight::DataSet.ColumnLevelPermissionRule`.
|
|
212
|
+
* <p>A rule defined to grant access on one or more restricted columns.
|
|
213
|
+
Each dataset can have multiple rules.
|
|
214
|
+
To create a restricted column, you add it to one or more rules.
|
|
215
|
+
Each rule must contain at least one column and at least one user or group.
|
|
216
|
+
To be able to see a restricted column, a user or group needs to be added
|
|
217
|
+
to a rule for that column.</p>
|
|
199
218
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnlevelpermissionrule.html}
|
|
200
219
|
*/
|
|
201
220
|
export type ColumnLevelPermissionRule = {
|
|
202
221
|
/**
|
|
222
|
+
* <p>An array of column names.</p>
|
|
203
223
|
* @minLength `1`
|
|
204
224
|
*/
|
|
205
225
|
ColumnNames?: string[];
|
|
206
226
|
/**
|
|
227
|
+
* <p>An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.</p>
|
|
207
228
|
* @minLength `1`
|
|
208
229
|
* @maxLength `100`
|
|
209
230
|
*/
|
|
210
231
|
Principals?: string[];
|
|
211
232
|
};
|
|
212
|
-
/**
|
|
213
|
-
* Type definition for `AWS::QuickSight::DataSet.ColumnSubDataType`.
|
|
214
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columnsubdatatype.html}
|
|
215
|
-
*/
|
|
216
|
-
export type ColumnSubDataType = "FIXED" | "FLOAT";
|
|
217
233
|
/**
|
|
218
234
|
* Type definition for `AWS::QuickSight::DataSet.ColumnTag`.
|
|
219
|
-
* <p>A tag for a column in a
|
|
235
|
+
* <p>A tag for a column in a
|
|
236
|
+
<code>
|
|
237
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html">TagColumnOperation</a>
|
|
238
|
+
</code>
|
|
239
|
+
structure. This is a
|
|
220
240
|
variant type structure. For this structure to be valid, only one of the attributes can
|
|
221
241
|
be non-null.</p>
|
|
222
242
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntag.html}
|
|
@@ -228,6 +248,11 @@ export type ColumnTag = {
|
|
|
228
248
|
ColumnDescription?: ColumnDescription;
|
|
229
249
|
ColumnGeographicRole?: GeoSpatialDataRole;
|
|
230
250
|
};
|
|
251
|
+
/**
|
|
252
|
+
* Type definition for `AWS::QuickSight::DataSet.ColumnTagName`.
|
|
253
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-columntagname.html}
|
|
254
|
+
*/
|
|
255
|
+
export type ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE" | "COLUMN_DESCRIPTION";
|
|
231
256
|
/**
|
|
232
257
|
* Type definition for `AWS::QuickSight::DataSet.CreateColumnsOperation`.
|
|
233
258
|
* <p>A transform operation that creates calculated columns. Columns created in one such
|
|
@@ -267,7 +292,7 @@ export type CustomSql = {
|
|
|
267
292
|
/**
|
|
268
293
|
* <p>The SQL query.</p>
|
|
269
294
|
* @minLength `1`
|
|
270
|
-
* @maxLength `
|
|
295
|
+
* @maxLength `168000`
|
|
271
296
|
*/
|
|
272
297
|
SqlQuery: string;
|
|
273
298
|
};
|
|
@@ -278,149 +303,151 @@ export type CustomSql = {
|
|
|
278
303
|
export type DataSetImportMode = "SPICE" | "DIRECT_QUERY";
|
|
279
304
|
/**
|
|
280
305
|
* Type definition for `AWS::QuickSight::DataSet.DatasetParameter`.
|
|
281
|
-
* <p>A
|
|
306
|
+
* <p>A dataset parameter.</p>
|
|
282
307
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparameter.html}
|
|
283
308
|
*/
|
|
284
309
|
export type DatasetParameter = {
|
|
285
310
|
/**
|
|
286
|
-
* <p>A parameter
|
|
311
|
+
* <p>A date time parameter for a dataset.</p>
|
|
287
312
|
*/
|
|
288
313
|
DateTimeDatasetParameter?: DateTimeDatasetParameter;
|
|
289
314
|
/**
|
|
290
|
-
* <p>A parameter
|
|
315
|
+
* <p>A decimal parameter for a dataset.</p>
|
|
291
316
|
*/
|
|
292
317
|
DecimalDatasetParameter?: DecimalDatasetParameter;
|
|
293
318
|
/**
|
|
294
|
-
* <p>
|
|
319
|
+
* <p>An integer parameter for a dataset.</p>
|
|
295
320
|
*/
|
|
296
321
|
IntegerDatasetParameter?: IntegerDatasetParameter;
|
|
297
322
|
/**
|
|
298
|
-
* <p>A parameter
|
|
323
|
+
* <p>A string parameter for a dataset.</p>
|
|
299
324
|
*/
|
|
300
325
|
StringDatasetParameter?: StringDatasetParameter;
|
|
301
326
|
};
|
|
302
327
|
/**
|
|
303
328
|
* Type definition for `AWS::QuickSight::DataSet.DatasetParameterValueType`.
|
|
304
|
-
* <p>Every parameter value could be either a single value or multi value which helps to validate before evaluation.</p>
|
|
305
329
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetparametervaluetype.html}
|
|
306
330
|
*/
|
|
307
331
|
export type DatasetParameterValueType = "MULTI_VALUED" | "SINGLE_VALUED";
|
|
308
332
|
/**
|
|
309
333
|
* Type definition for `AWS::QuickSight::DataSet.DataSetRefreshProperties`.
|
|
310
|
-
* <p>The
|
|
334
|
+
* <p>The refresh properties of a dataset.</p>
|
|
311
335
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html}
|
|
312
336
|
*/
|
|
313
337
|
export type DataSetRefreshProperties = {
|
|
314
338
|
/**
|
|
315
|
-
* <p>
|
|
339
|
+
* <p>The refresh configuration of a dataset.</p>
|
|
316
340
|
*/
|
|
317
|
-
RefreshConfiguration
|
|
341
|
+
RefreshConfiguration: RefreshConfiguration;
|
|
318
342
|
};
|
|
319
343
|
/**
|
|
320
344
|
* Type definition for `AWS::QuickSight::DataSet.DataSetUsageConfiguration`.
|
|
321
|
-
* <p>The
|
|
345
|
+
* <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
|
|
322
346
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetusageconfiguration.html}
|
|
323
347
|
*/
|
|
324
348
|
export type DataSetUsageConfiguration = {
|
|
349
|
+
/**
|
|
350
|
+
* <p>An option that controls whether a child dataset of a direct query can use this dataset as a source.</p>
|
|
351
|
+
*/
|
|
325
352
|
DisableUseAsDirectQuerySource?: boolean;
|
|
353
|
+
/**
|
|
354
|
+
* <p>An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.</p>
|
|
355
|
+
*/
|
|
326
356
|
DisableUseAsImportedSource?: boolean;
|
|
327
357
|
};
|
|
328
358
|
/**
|
|
329
359
|
* Type definition for `AWS::QuickSight::DataSet.DateTimeDatasetParameter`.
|
|
330
|
-
* <p>A parameter
|
|
360
|
+
* <p>A date time parameter for a dataset.</p>
|
|
331
361
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameter.html}
|
|
332
362
|
*/
|
|
333
363
|
export type DateTimeDatasetParameter = {
|
|
334
364
|
/**
|
|
335
|
-
* <p>
|
|
365
|
+
* <p>The default values of a date time parameter.</p>
|
|
336
366
|
*/
|
|
337
367
|
DefaultValues?: DateTimeDatasetParameterDefaultValues;
|
|
338
368
|
/**
|
|
339
|
-
* <p>
|
|
369
|
+
* <p>An identifier for the parameter that is created in the dataset.</p>
|
|
340
370
|
* @minLength `1`
|
|
341
371
|
* @maxLength `128`
|
|
342
372
|
* @pattern `^[a-zA-Z0-9-]+$`
|
|
343
373
|
*/
|
|
344
374
|
Id: string;
|
|
345
375
|
/**
|
|
346
|
-
* <p>
|
|
376
|
+
* <p>The name of the date time parameter that is created in the dataset.</p>
|
|
347
377
|
* @minLength `1`
|
|
348
378
|
* @maxLength `2048`
|
|
349
379
|
* @pattern `^[a-zA-Z0-9]+$`
|
|
350
380
|
*/
|
|
351
381
|
Name: string;
|
|
352
382
|
TimeGranularity?: TimeGranularity;
|
|
353
|
-
/**
|
|
354
|
-
* <p>Every parameter value could be either a single value or multi value which helps to validate before evaluation.</p>
|
|
355
|
-
*/
|
|
356
383
|
ValueType: DatasetParameterValueType;
|
|
357
384
|
};
|
|
358
385
|
/**
|
|
359
386
|
* Type definition for `AWS::QuickSight::DataSet.DateTimeDatasetParameterDefaultValues`.
|
|
360
|
-
* <p>
|
|
387
|
+
* <p>The default values of a date time parameter.</p>
|
|
361
388
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datetimedatasetparameterdefaultvalues.html}
|
|
362
389
|
*/
|
|
363
390
|
export type DateTimeDatasetParameterDefaultValues = {
|
|
364
391
|
/**
|
|
365
|
-
* <p>
|
|
366
|
-
* @minLength `
|
|
392
|
+
* <p>A list of static default values for a given date time parameter.</p>
|
|
393
|
+
* @minLength `0`
|
|
367
394
|
* @maxLength `32`
|
|
368
395
|
*/
|
|
369
396
|
StaticValues?: string[];
|
|
370
397
|
};
|
|
371
398
|
/**
|
|
372
399
|
* Type definition for `AWS::QuickSight::DataSet.DecimalDatasetParameter`.
|
|
373
|
-
* <p>A parameter
|
|
400
|
+
* <p>A decimal parameter for a dataset.</p>
|
|
374
401
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameter.html}
|
|
375
402
|
*/
|
|
376
403
|
export type DecimalDatasetParameter = {
|
|
377
404
|
/**
|
|
378
|
-
* <p>
|
|
405
|
+
* <p>The default values of a decimal parameter.</p>
|
|
379
406
|
*/
|
|
380
407
|
DefaultValues?: DecimalDatasetParameterDefaultValues;
|
|
381
408
|
/**
|
|
382
|
-
* <p>
|
|
409
|
+
* <p>An identifier for the decimal parameter created in the dataset.</p>
|
|
383
410
|
* @minLength `1`
|
|
384
411
|
* @maxLength `128`
|
|
385
412
|
* @pattern `^[a-zA-Z0-9-]+$`
|
|
386
413
|
*/
|
|
387
414
|
Id: string;
|
|
388
415
|
/**
|
|
389
|
-
* <p>
|
|
416
|
+
* <p>The name of the decimal parameter that is created in the dataset.</p>
|
|
390
417
|
* @minLength `1`
|
|
391
418
|
* @maxLength `2048`
|
|
392
419
|
* @pattern `^[a-zA-Z0-9]+$`
|
|
393
420
|
*/
|
|
394
421
|
Name: string;
|
|
395
|
-
/**
|
|
396
|
-
* <p>Every parameter value could be either a single value or multi value which helps to validate before evaluation.</p>
|
|
397
|
-
*/
|
|
398
422
|
ValueType: DatasetParameterValueType;
|
|
399
423
|
};
|
|
400
424
|
/**
|
|
401
425
|
* Type definition for `AWS::QuickSight::DataSet.DecimalDatasetParameterDefaultValues`.
|
|
402
|
-
* <p>
|
|
426
|
+
* <p>The default values of a decimal parameter.</p>
|
|
403
427
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-decimaldatasetparameterdefaultvalues.html}
|
|
404
428
|
*/
|
|
405
429
|
export type DecimalDatasetParameterDefaultValues = {
|
|
406
430
|
/**
|
|
407
|
-
* <p>
|
|
408
|
-
* @minLength `
|
|
431
|
+
* <p>A list of static default values for a given decimal parameter.</p>
|
|
432
|
+
* @minLength `0`
|
|
409
433
|
* @maxLength `32`
|
|
410
434
|
*/
|
|
411
435
|
StaticValues?: number[];
|
|
412
436
|
};
|
|
413
437
|
/**
|
|
414
438
|
* Type definition for `AWS::QuickSight::DataSet.FieldFolder`.
|
|
439
|
+
* <p>A FieldFolder element is a folder that contains fields and nested subfolders.</p>
|
|
415
440
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfolder.html}
|
|
416
441
|
*/
|
|
417
442
|
export type FieldFolder = {
|
|
418
443
|
/**
|
|
444
|
+
* <p>A folder has a list of columns. A column can only be in one folder.</p>
|
|
419
445
|
* @minLength `0`
|
|
420
446
|
* @maxLength `5000`
|
|
421
447
|
*/
|
|
422
448
|
Columns?: string[];
|
|
423
449
|
/**
|
|
450
|
+
* <p>The description for a field folder.</p>
|
|
424
451
|
* @minLength `0`
|
|
425
452
|
* @maxLength `500`
|
|
426
453
|
*/
|
|
@@ -479,14 +506,17 @@ export type GeoSpatialCountryCode = "US";
|
|
|
479
506
|
* Type definition for `AWS::QuickSight::DataSet.GeoSpatialDataRole`.
|
|
480
507
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-geospatialdatarole.html}
|
|
481
508
|
*/
|
|
482
|
-
export type GeoSpatialDataRole = "COUNTRY" | "STATE" | "COUNTY" | "CITY" | "POSTCODE" | "LONGITUDE" | "LATITUDE" | "POLITICAL1";
|
|
509
|
+
export type GeoSpatialDataRole = "COUNTRY" | "STATE" | "COUNTY" | "CITY" | "POSTCODE" | "LONGITUDE" | "LATITUDE" | "POLITICAL1" | "CENSUS_TRACT" | "CENSUS_BLOCK_GROUP" | "CENSUS_BLOCK";
|
|
483
510
|
/**
|
|
484
511
|
* Type definition for `AWS::QuickSight::DataSet.IncrementalRefresh`.
|
|
485
|
-
* <p>
|
|
512
|
+
* <p>The incremental refresh configuration for a dataset.</p>
|
|
486
513
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-incrementalrefresh.html}
|
|
487
514
|
*/
|
|
488
515
|
export type IncrementalRefresh = {
|
|
489
|
-
|
|
516
|
+
/**
|
|
517
|
+
* <p>The lookback window setup of an incremental refresh configuration.</p>
|
|
518
|
+
*/
|
|
519
|
+
LookbackWindow: LookbackWindow;
|
|
490
520
|
};
|
|
491
521
|
/**
|
|
492
522
|
* Type definition for `AWS::QuickSight::DataSet.IngestionWaitPolicy`.
|
|
@@ -516,10 +546,10 @@ export type InputColumn = {
|
|
|
516
546
|
/**
|
|
517
547
|
* <p>The name of this column in the underlying data source.</p>
|
|
518
548
|
* @minLength `1`
|
|
519
|
-
* @maxLength `
|
|
549
|
+
* @maxLength `127`
|
|
520
550
|
*/
|
|
521
551
|
Name: string;
|
|
522
|
-
SubType?:
|
|
552
|
+
SubType?: ColumnDataSubType;
|
|
523
553
|
Type: InputColumnDataType;
|
|
524
554
|
};
|
|
525
555
|
/**
|
|
@@ -529,81 +559,89 @@ export type InputColumn = {
|
|
|
529
559
|
export type InputColumnDataType = "STRING" | "INTEGER" | "DECIMAL" | "DATETIME" | "BIT" | "BOOLEAN" | "JSON";
|
|
530
560
|
/**
|
|
531
561
|
* Type definition for `AWS::QuickSight::DataSet.IntegerDatasetParameter`.
|
|
532
|
-
* <p>
|
|
562
|
+
* <p>An integer parameter for a dataset.</p>
|
|
533
563
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameter.html}
|
|
534
564
|
*/
|
|
535
565
|
export type IntegerDatasetParameter = {
|
|
536
566
|
/**
|
|
537
|
-
* <p>
|
|
567
|
+
* <p>The default values of an integer parameter.</p>
|
|
538
568
|
*/
|
|
539
569
|
DefaultValues?: IntegerDatasetParameterDefaultValues;
|
|
540
570
|
/**
|
|
541
|
-
* <p>
|
|
571
|
+
* <p>An identifier for the integer parameter created in the dataset.</p>
|
|
542
572
|
* @minLength `1`
|
|
543
573
|
* @maxLength `128`
|
|
544
574
|
* @pattern `^[a-zA-Z0-9-]+$`
|
|
545
575
|
*/
|
|
546
576
|
Id: string;
|
|
547
577
|
/**
|
|
548
|
-
* <p>
|
|
578
|
+
* <p>The name of the integer parameter that is created in the dataset.</p>
|
|
549
579
|
* @minLength `1`
|
|
550
580
|
* @maxLength `2048`
|
|
551
581
|
* @pattern `^[a-zA-Z0-9]+$`
|
|
552
582
|
*/
|
|
553
583
|
Name: string;
|
|
554
|
-
/**
|
|
555
|
-
* <p>Every parameter value could be either a single value or multi value which helps to validate before evaluation.</p>
|
|
556
|
-
*/
|
|
557
584
|
ValueType: DatasetParameterValueType;
|
|
558
585
|
};
|
|
559
586
|
/**
|
|
560
587
|
* Type definition for `AWS::QuickSight::DataSet.IntegerDatasetParameterDefaultValues`.
|
|
561
|
-
* <p>
|
|
588
|
+
* <p>The default values of an integer parameter.</p>
|
|
562
589
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-integerdatasetparameterdefaultvalues.html}
|
|
563
590
|
*/
|
|
564
591
|
export type IntegerDatasetParameterDefaultValues = {
|
|
565
592
|
/**
|
|
566
|
-
* <p>
|
|
567
|
-
* @minLength `
|
|
593
|
+
* <p>A list of static default values for a given integer parameter.</p>
|
|
594
|
+
* @minLength `0`
|
|
568
595
|
* @maxLength `32`
|
|
569
596
|
*/
|
|
570
597
|
StaticValues?: number[];
|
|
571
598
|
};
|
|
572
599
|
/**
|
|
573
600
|
* Type definition for `AWS::QuickSight::DataSet.JoinInstruction`.
|
|
574
|
-
* <p>
|
|
601
|
+
* <p>The instructions associated with a join. </p>
|
|
575
602
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joininstruction.html}
|
|
576
603
|
*/
|
|
577
604
|
export type JoinInstruction = {
|
|
605
|
+
/**
|
|
606
|
+
* <p>Properties associated with the columns participating in a join.</p>
|
|
607
|
+
*/
|
|
578
608
|
LeftJoinKeyProperties?: JoinKeyProperties;
|
|
579
609
|
/**
|
|
580
|
-
* <p>
|
|
610
|
+
* <p>The operand on the left side of a join.</p>
|
|
581
611
|
* @minLength `1`
|
|
582
612
|
* @maxLength `64`
|
|
583
|
-
* @pattern
|
|
613
|
+
* @pattern `^[0-9a-zA-Z-]*$`
|
|
584
614
|
*/
|
|
585
615
|
LeftOperand: string;
|
|
586
616
|
/**
|
|
587
|
-
* <p>
|
|
617
|
+
* <p>The join instructions provided in the <code>ON</code> clause of a join.</p>
|
|
588
618
|
* @minLength `1`
|
|
589
619
|
* @maxLength `512`
|
|
590
620
|
*/
|
|
591
621
|
OnClause: string;
|
|
622
|
+
/**
|
|
623
|
+
* <p>Properties associated with the columns participating in a join.</p>
|
|
624
|
+
*/
|
|
592
625
|
RightJoinKeyProperties?: JoinKeyProperties;
|
|
593
626
|
/**
|
|
594
|
-
* <p>
|
|
627
|
+
* <p>The operand on the right side of a join.</p>
|
|
595
628
|
* @minLength `1`
|
|
596
629
|
* @maxLength `64`
|
|
597
|
-
* @pattern
|
|
630
|
+
* @pattern `^[0-9a-zA-Z-]*$`
|
|
598
631
|
*/
|
|
599
632
|
RightOperand: string;
|
|
600
633
|
Type: JoinType;
|
|
601
634
|
};
|
|
602
635
|
/**
|
|
603
636
|
* Type definition for `AWS::QuickSight::DataSet.JoinKeyProperties`.
|
|
637
|
+
* <p>Properties associated with the columns participating in a join.</p>
|
|
604
638
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-joinkeyproperties.html}
|
|
605
639
|
*/
|
|
606
640
|
export type JoinKeyProperties = {
|
|
641
|
+
/**
|
|
642
|
+
* <p>A value that indicates that a row in a table is uniquely identified by the columns in
|
|
643
|
+
a join key. This is used by Amazon QuickSight to optimize query performance.</p>
|
|
644
|
+
*/
|
|
607
645
|
UniqueKey?: boolean;
|
|
608
646
|
};
|
|
609
647
|
/**
|
|
@@ -627,7 +665,7 @@ export type LogicalTable = {
|
|
|
627
665
|
*/
|
|
628
666
|
Alias: string;
|
|
629
667
|
/**
|
|
630
|
-
* <p>Transform operations that act on this logical table
|
|
668
|
+
* <p>Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null. </p>
|
|
631
669
|
* @minLength `1`
|
|
632
670
|
* @maxLength `2048`
|
|
633
671
|
*/
|
|
@@ -651,59 +689,70 @@ export type LogicalTableMap = Record<string, LogicalTable>;
|
|
|
651
689
|
*/
|
|
652
690
|
export type LogicalTableSource = {
|
|
653
691
|
/**
|
|
654
|
-
* <p>The Amazon Resource
|
|
692
|
+
* <p>The Amazon Resource Number (ARN) of the parent dataset.</p>
|
|
655
693
|
*/
|
|
656
694
|
DataSetArn?: string;
|
|
657
695
|
/**
|
|
658
|
-
* <p>
|
|
696
|
+
* <p>The instructions associated with a join. </p>
|
|
659
697
|
*/
|
|
660
698
|
JoinInstruction?: JoinInstruction;
|
|
661
699
|
/**
|
|
662
700
|
* <p>Physical table ID.</p>
|
|
663
701
|
* @minLength `1`
|
|
664
702
|
* @maxLength `64`
|
|
665
|
-
* @pattern
|
|
703
|
+
* @pattern `^[0-9a-zA-Z-]*$`
|
|
666
704
|
*/
|
|
667
705
|
PhysicalTableId?: string;
|
|
668
706
|
};
|
|
669
707
|
/**
|
|
670
708
|
* Type definition for `AWS::QuickSight::DataSet.LookbackWindow`.
|
|
709
|
+
* <p>The lookback window setup of an incremental refresh configuration.</p>
|
|
671
710
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindow.html}
|
|
672
711
|
*/
|
|
673
712
|
export type LookbackWindow = {
|
|
674
713
|
/**
|
|
675
|
-
* <p>
|
|
714
|
+
* <p>The name of the lookback window column.</p>
|
|
676
715
|
*/
|
|
677
|
-
ColumnName
|
|
716
|
+
ColumnName: string;
|
|
678
717
|
/**
|
|
679
|
-
* <p>
|
|
718
|
+
* <p>The lookback window column size.</p>
|
|
680
719
|
* @min `1`
|
|
681
720
|
*/
|
|
682
|
-
Size
|
|
683
|
-
SizeUnit
|
|
721
|
+
Size: number;
|
|
722
|
+
SizeUnit: LookbackWindowSizeUnit;
|
|
684
723
|
};
|
|
724
|
+
/**
|
|
725
|
+
* Type definition for `AWS::QuickSight::DataSet.LookbackWindowSizeUnit`.
|
|
726
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-lookbackwindowsizeunit.html}
|
|
727
|
+
*/
|
|
728
|
+
export type LookbackWindowSizeUnit = "HOUR" | "DAY" | "WEEK";
|
|
685
729
|
/**
|
|
686
730
|
* Type definition for `AWS::QuickSight::DataSet.NewDefaultValues`.
|
|
731
|
+
* <p>The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.</p>
|
|
687
732
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-newdefaultvalues.html}
|
|
688
733
|
*/
|
|
689
734
|
export type NewDefaultValues = {
|
|
690
735
|
/**
|
|
691
|
-
*
|
|
736
|
+
* <p>A list of static default values for a given date time parameter.</p>
|
|
737
|
+
* @minLength `0`
|
|
692
738
|
* @maxLength `32`
|
|
693
739
|
*/
|
|
694
740
|
DateTimeStaticValues?: string[];
|
|
695
741
|
/**
|
|
696
|
-
*
|
|
742
|
+
* <p>A list of static default values for a given decimal parameter.</p>
|
|
743
|
+
* @minLength `0`
|
|
697
744
|
* @maxLength `32`
|
|
698
745
|
*/
|
|
699
746
|
DecimalStaticValues?: number[];
|
|
700
747
|
/**
|
|
701
|
-
*
|
|
748
|
+
* <p>A list of static default values for a given integer parameter.</p>
|
|
749
|
+
* @minLength `0`
|
|
702
750
|
* @maxLength `32`
|
|
703
751
|
*/
|
|
704
752
|
IntegerStaticValues?: number[];
|
|
705
753
|
/**
|
|
706
|
-
*
|
|
754
|
+
* <p>A list of static default values for a given string parameter.</p>
|
|
755
|
+
* @minLength `0`
|
|
707
756
|
* @maxLength `32`
|
|
708
757
|
*/
|
|
709
758
|
StringStaticValues?: string[];
|
|
@@ -721,22 +770,22 @@ export type OutputColumn = {
|
|
|
721
770
|
*/
|
|
722
771
|
Description?: string;
|
|
723
772
|
/**
|
|
724
|
-
* <p>
|
|
773
|
+
* <p>The display name of the column..</p>
|
|
725
774
|
* @minLength `1`
|
|
726
|
-
* @maxLength `
|
|
775
|
+
* @maxLength `127`
|
|
727
776
|
*/
|
|
728
777
|
Name?: string;
|
|
729
|
-
SubType?:
|
|
778
|
+
SubType?: ColumnDataSubType;
|
|
730
779
|
Type?: ColumnDataType;
|
|
731
780
|
};
|
|
732
781
|
/**
|
|
733
782
|
* Type definition for `AWS::QuickSight::DataSet.OverrideDatasetParameterOperation`.
|
|
734
|
-
* <p>A transform operation that overrides the dataset parameter values defined in another dataset.</p>
|
|
783
|
+
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
735
784
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-overridedatasetparameteroperation.html}
|
|
736
785
|
*/
|
|
737
786
|
export type OverrideDatasetParameterOperation = {
|
|
738
787
|
/**
|
|
739
|
-
* <p>The
|
|
788
|
+
* <p>The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.</p>
|
|
740
789
|
*/
|
|
741
790
|
NewDefaultValues?: NewDefaultValues;
|
|
742
791
|
/**
|
|
@@ -771,7 +820,7 @@ export type PhysicalTable = {
|
|
|
771
820
|
*/
|
|
772
821
|
RelationalTable?: RelationalTable;
|
|
773
822
|
/**
|
|
774
|
-
* <p>A physical table type for
|
|
823
|
+
* <p>A physical table type for an S3 data source.</p>
|
|
775
824
|
*/
|
|
776
825
|
S3Source?: S3Source;
|
|
777
826
|
};
|
|
@@ -796,14 +845,14 @@ export type ProjectOperation = {
|
|
|
796
845
|
};
|
|
797
846
|
/**
|
|
798
847
|
* Type definition for `AWS::QuickSight::DataSet.RefreshConfiguration`.
|
|
799
|
-
* <p>
|
|
848
|
+
* <p>The refresh configuration of a dataset.</p>
|
|
800
849
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshconfiguration.html}
|
|
801
850
|
*/
|
|
802
851
|
export type RefreshConfiguration = {
|
|
803
852
|
/**
|
|
804
|
-
* <p>
|
|
853
|
+
* <p>The incremental refresh configuration for a dataset.</p>
|
|
805
854
|
*/
|
|
806
|
-
IncrementalRefresh
|
|
855
|
+
IncrementalRefresh: IncrementalRefresh;
|
|
807
856
|
};
|
|
808
857
|
/**
|
|
809
858
|
* Type definition for `AWS::QuickSight::DataSet.RelationalTable`.
|
|
@@ -830,13 +879,13 @@ export type RelationalTable = {
|
|
|
830
879
|
/**
|
|
831
880
|
* <p>The name of the relational table.</p>
|
|
832
881
|
* @minLength `1`
|
|
833
|
-
* @maxLength `
|
|
882
|
+
* @maxLength `256`
|
|
834
883
|
*/
|
|
835
884
|
Name: string;
|
|
836
885
|
/**
|
|
837
886
|
* <p>The schema name. This name applies to certain relational database engines.</p>
|
|
838
887
|
* @minLength `0`
|
|
839
|
-
* @maxLength `
|
|
888
|
+
* @maxLength `256`
|
|
840
889
|
*/
|
|
841
890
|
Schema?: string;
|
|
842
891
|
};
|
|
@@ -849,13 +898,13 @@ export type RenameColumnOperation = {
|
|
|
849
898
|
/**
|
|
850
899
|
* <p>The name of the column to be renamed.</p>
|
|
851
900
|
* @minLength `1`
|
|
852
|
-
* @maxLength `
|
|
901
|
+
* @maxLength `127`
|
|
853
902
|
*/
|
|
854
903
|
ColumnName: string;
|
|
855
904
|
/**
|
|
856
905
|
* <p>The new name for the column.</p>
|
|
857
906
|
* @minLength `1`
|
|
858
|
-
* @maxLength `
|
|
907
|
+
* @maxLength `127`
|
|
859
908
|
*/
|
|
860
909
|
NewColumnName: string;
|
|
861
910
|
};
|
|
@@ -874,16 +923,16 @@ export type ResourcePermission = {
|
|
|
874
923
|
/**
|
|
875
924
|
* <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
|
|
876
925
|
following:</p>
|
|
877
|
-
|
|
926
|
+
<ul>
|
|
878
927
|
<li>
|
|
879
|
-
|
|
928
|
+
<p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
|
|
880
929
|
</li>
|
|
881
930
|
<li>
|
|
882
|
-
|
|
931
|
+
<p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
|
|
883
932
|
</li>
|
|
884
933
|
<li>
|
|
885
|
-
|
|
886
|
-
ARN. Use this option only to share resources (templates) across
|
|
934
|
+
<p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
|
|
935
|
+
ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
|
|
887
936
|
(This is less common.) </p>
|
|
888
937
|
</li>
|
|
889
938
|
</ul>
|
|
@@ -894,17 +943,22 @@ export type ResourcePermission = {
|
|
|
894
943
|
};
|
|
895
944
|
/**
|
|
896
945
|
* Type definition for `AWS::QuickSight::DataSet.RowLevelPermissionDataSet`.
|
|
897
|
-
* <p>
|
|
946
|
+
* <p>Information about a dataset that contains permissions for row-level security (RLS).
|
|
947
|
+
The permissions dataset maps fields to users or groups. For more information, see
|
|
948
|
+
<a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User
|
|
949
|
+
Guide</i>.</p>
|
|
950
|
+
<p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is
|
|
951
|
+
not supported for new RLS datasets.</p>
|
|
898
952
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiondataset.html}
|
|
899
953
|
*/
|
|
900
954
|
export type RowLevelPermissionDataSet = {
|
|
901
955
|
/**
|
|
902
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
956
|
+
* <p>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</p>
|
|
903
957
|
*/
|
|
904
958
|
Arn: string;
|
|
905
959
|
FormatVersion?: RowLevelPermissionFormatVersion;
|
|
906
960
|
/**
|
|
907
|
-
* <p>The namespace associated with the
|
|
961
|
+
* <p>The namespace associated with the dataset that contains permissions for RLS.</p>
|
|
908
962
|
* @minLength `0`
|
|
909
963
|
* @maxLength `64`
|
|
910
964
|
* @pattern `^[a-zA-Z0-9._-]*$`
|
|
@@ -925,7 +979,7 @@ export type RowLevelPermissionFormatVersion = "VERSION_1" | "VERSION_2";
|
|
|
925
979
|
export type RowLevelPermissionPolicy = "GRANT_ACCESS" | "DENY_ACCESS";
|
|
926
980
|
/**
|
|
927
981
|
* Type definition for `AWS::QuickSight::DataSet.RowLevelPermissionTagConfiguration`.
|
|
928
|
-
* <p>The configuration of tags on a dataset to set row-level security
|
|
982
|
+
* <p>The configuration of tags on a dataset to set row-level security. </p>
|
|
929
983
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagconfiguration.html}
|
|
930
984
|
*/
|
|
931
985
|
export type RowLevelPermissionTagConfiguration = {
|
|
@@ -945,7 +999,7 @@ export type RowLevelPermissionTagConfiguration = {
|
|
|
945
999
|
};
|
|
946
1000
|
/**
|
|
947
1001
|
* Type definition for `AWS::QuickSight::DataSet.RowLevelPermissionTagRule`.
|
|
948
|
-
* <p>
|
|
1002
|
+
* <p>A set of rules associated with a tag.</p>
|
|
949
1003
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-rowlevelpermissiontagrule.html}
|
|
950
1004
|
*/
|
|
951
1005
|
export type RowLevelPermissionTagRule = {
|
|
@@ -967,36 +1021,35 @@ export type RowLevelPermissionTagRule = {
|
|
|
967
1021
|
TagKey: string;
|
|
968
1022
|
/**
|
|
969
1023
|
* <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>
|
|
1024
|
+
* @minLength `0`
|
|
970
1025
|
* @maxLength `10`
|
|
971
1026
|
*/
|
|
972
1027
|
TagMultiValueDelimiter?: string;
|
|
973
1028
|
};
|
|
974
1029
|
/**
|
|
975
1030
|
* Type definition for `AWS::QuickSight::DataSet.S3Source`.
|
|
976
|
-
* <p>A physical table type for
|
|
1031
|
+
* <p>A physical table type for an S3 data source.</p>
|
|
977
1032
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-s3source.html}
|
|
978
1033
|
*/
|
|
979
1034
|
export type S3Source = {
|
|
980
1035
|
/**
|
|
981
|
-
* <p>The
|
|
1036
|
+
* <p>The Amazon Resource Name (ARN) for the data source.</p>
|
|
982
1037
|
*/
|
|
983
1038
|
DataSourceArn: string;
|
|
984
1039
|
/**
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
1040
|
+
* <p>A physical table type for an S3 data source.</p>
|
|
1041
|
+
<note>
|
|
1042
|
+
<p>For files that aren't JSON, only <code>STRING</code> data types are supported in input columns.</p>
|
|
1043
|
+
</note>
|
|
1044
|
+
* @minLength `1`
|
|
1045
|
+
* @maxLength `2048`
|
|
1046
|
+
*/
|
|
989
1047
|
InputColumns: InputColumn[];
|
|
990
1048
|
/**
|
|
991
1049
|
* <p>Information about the format for a source file or files.</p>
|
|
992
1050
|
*/
|
|
993
1051
|
UploadSettings?: UploadSettings;
|
|
994
1052
|
};
|
|
995
|
-
/**
|
|
996
|
-
* Type definition for `AWS::QuickSight::DataSet.SizeUnit`.
|
|
997
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-sizeunit.html}
|
|
998
|
-
*/
|
|
999
|
-
export type SizeUnit = "HOUR" | "DAY" | "WEEK";
|
|
1000
1053
|
/**
|
|
1001
1054
|
* Type definition for `AWS::QuickSight::DataSet.Status`.
|
|
1002
1055
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-status.html}
|
|
@@ -1004,42 +1057,39 @@ export type SizeUnit = "HOUR" | "DAY" | "WEEK";
|
|
|
1004
1057
|
export type Status = "ENABLED" | "DISABLED";
|
|
1005
1058
|
/**
|
|
1006
1059
|
* Type definition for `AWS::QuickSight::DataSet.StringDatasetParameter`.
|
|
1007
|
-
* <p>A parameter
|
|
1060
|
+
* <p>A string parameter for a dataset.</p>
|
|
1008
1061
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameter.html}
|
|
1009
1062
|
*/
|
|
1010
1063
|
export type StringDatasetParameter = {
|
|
1011
1064
|
/**
|
|
1012
|
-
* <p>
|
|
1065
|
+
* <p>The default values of a string parameter.</p>
|
|
1013
1066
|
*/
|
|
1014
1067
|
DefaultValues?: StringDatasetParameterDefaultValues;
|
|
1015
1068
|
/**
|
|
1016
|
-
* <p>
|
|
1069
|
+
* <p>An identifier for the string parameter that is created in the dataset.</p>
|
|
1017
1070
|
* @minLength `1`
|
|
1018
1071
|
* @maxLength `128`
|
|
1019
1072
|
* @pattern `^[a-zA-Z0-9-]+$`
|
|
1020
1073
|
*/
|
|
1021
1074
|
Id: string;
|
|
1022
1075
|
/**
|
|
1023
|
-
* <p>
|
|
1076
|
+
* <p>The name of the string parameter that is created in the dataset.</p>
|
|
1024
1077
|
* @minLength `1`
|
|
1025
1078
|
* @maxLength `2048`
|
|
1026
1079
|
* @pattern `^[a-zA-Z0-9]+$`
|
|
1027
1080
|
*/
|
|
1028
1081
|
Name: string;
|
|
1029
|
-
/**
|
|
1030
|
-
* <p>Every parameter value could be either a single value or multi value which helps to validate before evaluation.</p>
|
|
1031
|
-
*/
|
|
1032
1082
|
ValueType: DatasetParameterValueType;
|
|
1033
1083
|
};
|
|
1034
1084
|
/**
|
|
1035
1085
|
* Type definition for `AWS::QuickSight::DataSet.StringDatasetParameterDefaultValues`.
|
|
1036
|
-
* <p>
|
|
1086
|
+
* <p>The default values of a string parameter.</p>
|
|
1037
1087
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-stringdatasetparameterdefaultvalues.html}
|
|
1038
1088
|
*/
|
|
1039
1089
|
export type StringDatasetParameterDefaultValues = {
|
|
1040
1090
|
/**
|
|
1041
|
-
* <p>
|
|
1042
|
-
* @minLength `
|
|
1091
|
+
* <p>A list of static default values for a given string parameter.</p>
|
|
1092
|
+
* @minLength `0`
|
|
1043
1093
|
* @maxLength `32`
|
|
1044
1094
|
*/
|
|
1045
1095
|
StaticValues?: string[];
|
|
@@ -1073,14 +1123,14 @@ export type TagColumnOperation = {
|
|
|
1073
1123
|
/**
|
|
1074
1124
|
* <p>The column that this operation acts on.</p>
|
|
1075
1125
|
* @minLength `1`
|
|
1076
|
-
* @maxLength `
|
|
1126
|
+
* @maxLength `127`
|
|
1077
1127
|
*/
|
|
1078
1128
|
ColumnName: string;
|
|
1079
1129
|
/**
|
|
1080
|
-
* <p>The dataset column tag, currently only used for geospatial type tagging
|
|
1081
|
-
|
|
1082
|
-
<p>This is not tags for the
|
|
1083
|
-
|
|
1130
|
+
* <p>The dataset column tag, currently only used for geospatial type tagging.</p>
|
|
1131
|
+
<note>
|
|
1132
|
+
<p>This is not tags for the Amazon Web Services tagging feature.</p>
|
|
1133
|
+
</note>
|
|
1084
1134
|
* @minLength `1`
|
|
1085
1135
|
* @maxLength `16`
|
|
1086
1136
|
*/
|
|
@@ -1117,7 +1167,7 @@ export type TransformOperation = {
|
|
|
1117
1167
|
*/
|
|
1118
1168
|
FilterOperation?: FilterOperation;
|
|
1119
1169
|
/**
|
|
1120
|
-
* <p>A transform operation that overrides the dataset parameter values defined in another dataset.</p>
|
|
1170
|
+
* <p>A transform operation that overrides the dataset parameter values that are defined in another dataset.</p>
|
|
1121
1171
|
*/
|
|
1122
1172
|
OverrideDatasetParameterOperation?: OverrideDatasetParameterOperation;
|
|
1123
1173
|
/**
|
|
@@ -1133,6 +1183,27 @@ export type TransformOperation = {
|
|
|
1133
1183
|
* <p>A transform operation that tags a column with additional information.</p>
|
|
1134
1184
|
*/
|
|
1135
1185
|
TagColumnOperation?: TagColumnOperation;
|
|
1186
|
+
/**
|
|
1187
|
+
* <p>A transform operation that removes tags associated with a column.</p>
|
|
1188
|
+
*/
|
|
1189
|
+
UntagColumnOperation?: UntagColumnOperation;
|
|
1190
|
+
};
|
|
1191
|
+
/**
|
|
1192
|
+
* Type definition for `AWS::QuickSight::DataSet.UntagColumnOperation`.
|
|
1193
|
+
* <p>A transform operation that removes tags associated with a column.</p>
|
|
1194
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-untagcolumnoperation.html}
|
|
1195
|
+
*/
|
|
1196
|
+
export type UntagColumnOperation = {
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>The column that this operation acts on.</p>
|
|
1199
|
+
* @minLength `1`
|
|
1200
|
+
* @maxLength `127`
|
|
1201
|
+
*/
|
|
1202
|
+
ColumnName: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* <p>The column tags to remove from this column.</p>
|
|
1205
|
+
*/
|
|
1206
|
+
TagNames: ColumnTagName[];
|
|
1136
1207
|
};
|
|
1137
1208
|
/**
|
|
1138
1209
|
* Type definition for `AWS::QuickSight::DataSet.UploadSettings`.
|