@awboost/cfn-resource-types 0.1.294 → 0.1.295

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.
@@ -1,8 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource type definition for `AWS::IoT::JobTemplate`.
5
- * Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
4
+ * Resource Type definition for AWS::IoT::JobTemplate. Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
6
5
  * @see {@link https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html}
7
6
  */
8
7
  export type IoTJobTemplateProperties = {
@@ -232,8 +231,7 @@ export type Tag = {
232
231
  Value: string;
233
232
  };
234
233
  /**
235
- * Resource type definition for `AWS::IoT::JobTemplate`.
236
- * Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
234
+ * Resource Type definition for AWS::IoT::JobTemplate. Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
237
235
  * @see {@link https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html}
238
236
  */
239
237
  export declare class IoTJobTemplate extends $Resource<"AWS::IoT::JobTemplate", IoTJobTemplateProperties, IoTJobTemplateAttributes> {
@@ -1,7 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource type definition for `AWS::IoT::JobTemplate`.
4
- * Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
3
+ * Resource Type definition for AWS::IoT::JobTemplate. Job templates enable you to preconfigure jobs so that you can deploy them to multiple sets of target devices.
5
4
  * @see {@link https://docs.aws.amazon.com/iot/latest/developerguide/job-templates.html}
6
5
  */
7
6
  export class IoTJobTemplate extends $Resource {
@@ -179,6 +179,46 @@ export type AudioSpecification = {
179
179
  */
180
180
  MaxLengthMs: number;
181
181
  };
182
+ /**
183
+ * Type definition for `AWS::Lex::Bot.BedrockModelSpecification`.
184
+ * Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
185
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.html}
186
+ */
187
+ export type BedrockModelSpecification = {
188
+ /**
189
+ * The guardrail configuration in the Bedrock model specification details.
190
+ */
191
+ BedrockGuardrailConfiguration?: {
192
+ /**
193
+ * The unique guardrail id for the Bedrock guardrail configuration.
194
+ * @minLength `1`
195
+ * @maxLength `5000`
196
+ */
197
+ BedrockGuardrailIdentifier?: string;
198
+ /**
199
+ * The guardrail version for the Bedrock guardrail configuration.
200
+ * @minLength `1`
201
+ * @maxLength `5000`
202
+ */
203
+ BedrockGuardrailVersion?: string;
204
+ };
205
+ /**
206
+ * The custom prompt used in the Bedrock model specification details.
207
+ * @minLength `1`
208
+ * @maxLength `5000`
209
+ */
210
+ BedrockModelCustomPrompt?: string;
211
+ /**
212
+ * The Bedrock trace status in the Bedrock model specification details.
213
+ */
214
+ BedrockTraceStatus?: "ENABLED" | "DISABLED";
215
+ /**
216
+ * The ARN of the foundation model used in descriptive bot building.
217
+ * @minLength `1`
218
+ * @maxLength `5000`
219
+ */
220
+ ModelArn: string;
221
+ };
182
222
  /**
183
223
  * Type definition for `AWS::Lex::Bot.BotAliasLocaleSettings`.
184
224
  * You can use this parameter to specify a specific Lambda function to run different functions in different locales.
@@ -236,7 +276,7 @@ export type BotLocale = {
236
276
  */
237
277
  LocaleId: string;
238
278
  /**
239
- * The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.
279
+ * The specified confidence threshold for inserting the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent intents and AMAZON.QnAIntent.
240
280
  * @min `0`
241
281
  * @max `1`
242
282
  */
@@ -831,6 +871,10 @@ export type Intent = {
831
871
  * A unique identifier for the built-in intent to base this intent on.
832
872
  */
833
873
  ParentIntentSignature?: string;
874
+ /**
875
+ * Details about the the configuration of the built-in Amazon.QnAIntent.
876
+ */
877
+ QnAIntentConfiguration?: QnAIntentConfiguration;
834
878
  /**
835
879
  * A sample utterance that invokes an intent or respond to a slot elicitation prompt.
836
880
  */
@@ -1231,6 +1275,121 @@ export type PromptSpecification = {
1231
1275
  */
1232
1276
  PromptAttemptsSpecification?: Record<string, PromptAttemptSpecification>;
1233
1277
  };
1278
+ /**
1279
+ * Type definition for `AWS::Lex::Bot.QnAIntentConfiguration`.
1280
+ * Details about the the configuration of the built-in Amazon.QnAIntent.
1281
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnaintentconfiguration.html}
1282
+ */
1283
+ export type QnAIntentConfiguration = {
1284
+ /**
1285
+ * Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
1286
+ */
1287
+ BedrockModelConfiguration: BedrockModelSpecification;
1288
+ /**
1289
+ * Contains details about the configuration of the data source used for the AMAZON.QnAIntent.
1290
+ */
1291
+ DataSourceConfiguration: {
1292
+ /**
1293
+ * Contains details about the configuration of a Amazon Bedrock knowledge base.
1294
+ */
1295
+ BedrockKnowledgeStoreConfiguration?: {
1296
+ /**
1297
+ * Contains the names of the fields used for an exact response to the user.
1298
+ */
1299
+ BKBExactResponseFields?: {
1300
+ /**
1301
+ * The answer field used for an exact response from Bedrock Knowledge Store.
1302
+ * @minLength `1`
1303
+ * @maxLength `5000`
1304
+ */
1305
+ AnswerField?: string;
1306
+ };
1307
+ /**
1308
+ * The base ARN of the knowledge base used.
1309
+ * @minLength `1`
1310
+ * @maxLength `5000`
1311
+ */
1312
+ BedrockKnowledgeBaseArn?: string;
1313
+ /**
1314
+ * Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
1315
+ */
1316
+ ExactResponse?: boolean;
1317
+ };
1318
+ /**
1319
+ * Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.
1320
+ */
1321
+ KendraConfiguration?: QnAKendraConfiguration;
1322
+ /**
1323
+ * Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent.
1324
+ */
1325
+ OpensearchConfiguration?: {
1326
+ /**
1327
+ * The endpoint of the Amazon OpenSearch Service domain.
1328
+ * @minLength `1`
1329
+ * @maxLength `5000`
1330
+ */
1331
+ DomainEndpoint?: string;
1332
+ /**
1333
+ * Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
1334
+ */
1335
+ ExactResponse?: boolean;
1336
+ /**
1337
+ * Contains the names of the fields used for an exact response to the user.
1338
+ */
1339
+ ExactResponseFields?: {
1340
+ /**
1341
+ * The name of the field that contains the answer to the query made to the OpenSearch Service database.
1342
+ * @minLength `1`
1343
+ * @maxLength `5000`
1344
+ */
1345
+ AnswerField?: string;
1346
+ /**
1347
+ * The name of the field that contains the query made to the OpenSearch Service database.
1348
+ * @minLength `1`
1349
+ * @maxLength `5000`
1350
+ */
1351
+ QuestionField?: string;
1352
+ };
1353
+ /**
1354
+ * List of fields to include
1355
+ */
1356
+ IncludeFields?: string[];
1357
+ /**
1358
+ * The name of the Amazon OpenSearch Service index.
1359
+ * @minLength `1`
1360
+ * @maxLength `5000`
1361
+ */
1362
+ IndexName?: string;
1363
+ };
1364
+ };
1365
+ };
1366
+ /**
1367
+ * Type definition for `AWS::Lex::Bot.QnAKendraConfiguration`.
1368
+ * Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent.
1369
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.html}
1370
+ */
1371
+ export type QnAKendraConfiguration = {
1372
+ /**
1373
+ * Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results.
1374
+ */
1375
+ ExactResponse: boolean;
1376
+ /**
1377
+ * The ARN of the Amazon Kendra index to use.
1378
+ * @minLength `1`
1379
+ * @maxLength `5000`
1380
+ */
1381
+ KendraIndex: string;
1382
+ /**
1383
+ * Contains the Amazon Kendra filter string to use if enabled.
1384
+ * @minLength `1`
1385
+ * @maxLength `5000`
1386
+ */
1387
+ QueryFilterString?: string;
1388
+ /**
1389
+ * Specifies whether to enable an Amazon Kendra filter string or not.
1390
+ */
1391
+ QueryFilterStringEnabled: boolean;
1392
+ };
1234
1393
  /**
1235
1394
  * Type definition for `AWS::Lex::Bot.Replication`.
1236
1395
  * Parameter used to create a replication of the source bot in the secondary region.
@@ -1785,7 +1944,7 @@ export type VoiceSettings = {
1785
1944
  /**
1786
1945
  * Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
1787
1946
  */
1788
- Engine?: "standard" | "neural";
1947
+ Engine?: "standard" | "neural" | "long-form" | "generative";
1789
1948
  /**
1790
1949
  * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
1791
1950
  */
@@ -85,6 +85,7 @@ export type QuickSightDataSetProperties = {
85
85
  * @maxLength `200`
86
86
  */
87
87
  Tags?: Tag[];
88
+ UseAs?: DataSetUseAs;
88
89
  };
89
90
  /**
90
91
  * Attribute type definition for `AWS::QuickSight::DataSet`.
@@ -269,10 +270,10 @@ export type ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE" | "COLUMN_DESCRIPTION";
269
270
  export type CreateColumnsOperation = {
270
271
  /**
271
272
  * <p>Calculated columns to create.</p>
272
- * @minLength `1`
273
+ * @minLength `0`
273
274
  * @maxLength `128`
274
275
  */
275
- Columns: CalculatedColumn[];
276
+ Columns?: CalculatedColumn[];
276
277
  };
277
278
  /**
278
279
  * Type definition for `AWS::QuickSight::DataSet.CustomSql`.
@@ -342,6 +343,7 @@ export type DatasetParameterValueType = "MULTI_VALUED" | "SINGLE_VALUED";
342
343
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetrefreshproperties.html}
343
344
  */
344
345
  export type DataSetRefreshProperties = {
346
+ FailureConfiguration?: RefreshFailureConfiguration;
345
347
  /**
346
348
  * <p>The refresh configuration of a dataset.</p>
347
349
  */
@@ -362,6 +364,11 @@ export type DataSetUsageConfiguration = {
362
364
  */
363
365
  DisableUseAsImportedSource?: boolean;
364
366
  };
367
+ /**
368
+ * Type definition for `AWS::QuickSight::DataSet.DataSetUseAs`.
369
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-datasetuseas.html}
370
+ */
371
+ export type DataSetUseAs = "RLS_RULES";
365
372
  /**
366
373
  * Type definition for `AWS::QuickSight::DataSet.DateTimeDatasetParameter`.
367
374
  * <p>A date time parameter for a dataset.</p>
@@ -465,6 +472,11 @@ export type FieldFolder = {
465
472
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fieldfoldermap.html}
466
473
  */
467
474
  export type FieldFolderMap = Record<string, FieldFolder>;
475
+ /**
476
+ * Type definition for `AWS::QuickSight::DataSet.FileFormat`.
477
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-fileformat.html}
478
+ */
479
+ export type FileFormat = "CSV" | "TSV" | "CLF" | "ELF" | "XLSX" | "JSON";
468
480
  /**
469
481
  * Type definition for `AWS::QuickSight::DataSet.FilterOperation`.
470
482
  * <p>A transform operation that filters rows based on a condition.</p>
@@ -851,7 +863,7 @@ export type PhysicalTableMap = Record<string, PhysicalTable>;
851
863
  export type ProjectOperation = {
852
864
  /**
853
865
  * <p>Projected columns.</p>
854
- * @minLength `1`
866
+ * @minLength `0`
855
867
  * @maxLength `2000`
856
868
  */
857
869
  ProjectedColumns: string[];
@@ -867,6 +879,25 @@ export type RefreshConfiguration = {
867
879
  */
868
880
  IncrementalRefresh: IncrementalRefresh;
869
881
  };
882
+ /**
883
+ * Type definition for `AWS::QuickSight::DataSet.RefreshFailureAlertStatus`.
884
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailurealertstatus.html}
885
+ */
886
+ export type RefreshFailureAlertStatus = "ENABLED" | "DISABLED";
887
+ /**
888
+ * Type definition for `AWS::QuickSight::DataSet.RefreshFailureConfiguration`.
889
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureconfiguration.html}
890
+ */
891
+ export type RefreshFailureConfiguration = {
892
+ EmailAlert?: RefreshFailureEmailAlert;
893
+ };
894
+ /**
895
+ * Type definition for `AWS::QuickSight::DataSet.RefreshFailureEmailAlert`.
896
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-refreshfailureemailalert.html}
897
+ */
898
+ export type RefreshFailureEmailAlert = {
899
+ AlertStatus?: RefreshFailureAlertStatus;
900
+ };
870
901
  /**
871
902
  * Type definition for `AWS::QuickSight::DataSet.RelationalTable`.
872
903
  * <p>A physical table type for relational data sources.</p>
@@ -919,7 +950,7 @@ export type RenameColumnOperation = {
919
950
  * @minLength `1`
920
951
  * @maxLength `127`
921
952
  */
922
- NewColumnName: string;
953
+ NewColumnName?: string;
923
954
  };
924
955
  /**
925
956
  * Type definition for `AWS::QuickSight::DataSet.ResourcePermission`.
@@ -1057,8 +1088,11 @@ export type S3Source = {
1057
1088
  * @minLength `1`
1058
1089
  * @maxLength `2048`
1059
1090
  */
1060
- InputColumns: InputColumn[];
1061
- UploadSettings?: any;
1091
+ InputColumns?: InputColumn[];
1092
+ /**
1093
+ * <p>Information about the format for a source file or files.</p>
1094
+ */
1095
+ UploadSettings?: UploadSettings;
1062
1096
  };
1063
1097
  /**
1064
1098
  * Type definition for `AWS::QuickSight::DataSet.Status`.
@@ -1146,6 +1180,11 @@ export type TagColumnOperation = {
1146
1180
  */
1147
1181
  Tags: ColumnTag[];
1148
1182
  };
1183
+ /**
1184
+ * Type definition for `AWS::QuickSight::DataSet.TextQualifier`.
1185
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-textqualifier.html}
1186
+ */
1187
+ export type TextQualifier = "DOUBLE_QUOTE" | "SINGLE_QUOTE";
1149
1188
  /**
1150
1189
  * Type definition for `AWS::QuickSight::DataSet.TimeGranularity`.
1151
1190
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-timegranularity.html}
@@ -1221,6 +1260,30 @@ export type UntagColumnOperation = {
1221
1260
  */
1222
1261
  TagNames: ColumnTagName[];
1223
1262
  };
1263
+ /**
1264
+ * Type definition for `AWS::QuickSight::DataSet.UploadSettings`.
1265
+ * <p>Information about the format for a source file or files.</p>
1266
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-uploadsettings.html}
1267
+ */
1268
+ export type UploadSettings = {
1269
+ /**
1270
+ * <p>Whether the file has a header row, or the files each have a header row.</p>
1271
+ */
1272
+ ContainsHeader?: boolean;
1273
+ /**
1274
+ * <p>The delimiter between values in the file.</p>
1275
+ * @minLength `1`
1276
+ * @maxLength `1`
1277
+ */
1278
+ Delimiter?: string;
1279
+ Format?: FileFormat;
1280
+ /**
1281
+ * <p>A row number to start reading data from.</p>
1282
+ * @min `1`
1283
+ */
1284
+ StartFromRow?: number;
1285
+ TextQualifier?: TextQualifier;
1286
+ };
1224
1287
  /**
1225
1288
  * Definition of the AWS::QuickSight::DataSet Resource Type.
1226
1289
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.294",
3
+ "version": "0.1.295",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },