aws-cdk-lib 2.140.0__py3-none-any.whl → 2.141.0__py3-none-any.whl

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.

Potentially problematic release.


This version of aws-cdk-lib might be problematic. Click here for more details.

Files changed (33) hide show
  1. aws_cdk/_jsii/__init__.py +1 -1
  2. aws_cdk/_jsii/{aws-cdk-lib@2.140.0.jsii.tgz → aws-cdk-lib@2.141.0.jsii.tgz} +0 -0
  3. aws_cdk/aws_bedrock/__init__.py +51 -41
  4. aws_cdk/aws_cloudtrail/__init__.py +13 -4
  5. aws_cdk/aws_connectcampaigns/__init__.py +2 -2
  6. aws_cdk/aws_datasync/__init__.py +51 -56
  7. aws_cdk/aws_dynamodb/__init__.py +410 -0
  8. aws_cdk/aws_ec2/__init__.py +90 -40
  9. aws_cdk/aws_ecr/__init__.py +32 -7
  10. aws_cdk/aws_entityresolution/__init__.py +6 -2
  11. aws_cdk/aws_fms/__init__.py +7 -7
  12. aws_cdk/aws_gamelift/__init__.py +261 -160
  13. aws_cdk/aws_ivs/__init__.py +1 -3
  14. aws_cdk/aws_kms/__init__.py +11 -5
  15. aws_cdk/aws_location/__init__.py +8 -4
  16. aws_cdk/aws_oam/__init__.py +45 -11
  17. aws_cdk/aws_omics/__init__.py +4 -4
  18. aws_cdk/aws_paymentcryptography/__init__.py +128 -48
  19. aws_cdk/aws_pinpoint/__init__.py +7 -5
  20. aws_cdk/aws_qbusiness/__init__.py +620 -294
  21. aws_cdk/aws_quicksight/__init__.py +103 -40
  22. aws_cdk/aws_rds/__init__.py +38 -8
  23. aws_cdk/aws_route53profiles/__init__.py +49 -49
  24. aws_cdk/aws_sagemaker/__init__.py +30 -30
  25. aws_cdk/aws_ses/__init__.py +9 -9
  26. aws_cdk/aws_transfer/__init__.py +4 -4
  27. aws_cdk/aws_voiceid/__init__.py +2 -2
  28. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/METADATA +1 -1
  29. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/RECORD +33 -33
  30. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/LICENSE +0 -0
  31. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/NOTICE +0 -0
  32. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/WHEEL +0 -0
  33. {aws_cdk_lib-2.140.0.dist-info → aws_cdk_lib-2.141.0.dist-info}/top_level.txt +0 -0
@@ -70,7 +70,11 @@ class CfnApplication(
70
70
  metaclass=jsii.JSIIMeta,
71
71
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnApplication",
72
72
  ):
73
- '''Definition of AWS::QBusiness::Application Resource Type.
73
+ '''Creates an Amazon Q Business application.
74
+
75
+ .. epigraph::
76
+
77
+ There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see `Amazon Q Business tiers <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers>`_ . You must use the Amazon Q Business console to assign subscription tiers to users.
74
78
 
75
79
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
76
80
  :cloudformationResource: AWS::QBusiness::Application
@@ -118,13 +122,13 @@ class CfnApplication(
118
122
  '''
119
123
  :param scope: Scope in which this resource is defined.
120
124
  :param id: Construct identifier for this resource (unique in its scope).
121
- :param display_name:
122
- :param attachments_configuration:
123
- :param description:
124
- :param encryption_configuration:
125
- :param identity_center_instance_arn:
126
- :param role_arn:
127
- :param tags:
125
+ :param display_name: The name of the Amazon Q Business application.
126
+ :param attachments_configuration: Configuration information for the file upload during chat feature.
127
+ :param description: A description for the Amazon Q Business application.
128
+ :param encryption_configuration: Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
129
+ :param identity_center_instance_arn: The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. *Required* : ``Yes``
130
+ :param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
131
+ :param tags: A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
128
132
  '''
129
133
  if __debug__:
130
134
  type_hints = typing.get_type_hints(_typecheckingstub__e2c95edfee8896187b03149b15ce3604b3a59bfb3b08abd73c5672b7c0fc870b)
@@ -175,7 +179,8 @@ class CfnApplication(
175
179
  @builtins.property
176
180
  @jsii.member(jsii_name="attrApplicationArn")
177
181
  def attr_application_arn(self) -> builtins.str:
178
- '''
182
+ '''The Amazon Resource Name (ARN) of the Amazon Q Business application.
183
+
179
184
  :cloudformationAttribute: ApplicationArn
180
185
  '''
181
186
  return typing.cast(builtins.str, jsii.get(self, "attrApplicationArn"))
@@ -183,7 +188,8 @@ class CfnApplication(
183
188
  @builtins.property
184
189
  @jsii.member(jsii_name="attrApplicationId")
185
190
  def attr_application_id(self) -> builtins.str:
186
- '''
191
+ '''The identifier for the Amazon Q Business application.
192
+
187
193
  :cloudformationAttribute: ApplicationId
188
194
  '''
189
195
  return typing.cast(builtins.str, jsii.get(self, "attrApplicationId"))
@@ -191,7 +197,8 @@ class CfnApplication(
191
197
  @builtins.property
192
198
  @jsii.member(jsii_name="attrCreatedAt")
193
199
  def attr_created_at(self) -> builtins.str:
194
- '''
200
+ '''The Unix timestamp when the Amazon Q Business application was created.
201
+
195
202
  :cloudformationAttribute: CreatedAt
196
203
  '''
197
204
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -199,7 +206,8 @@ class CfnApplication(
199
206
  @builtins.property
200
207
  @jsii.member(jsii_name="attrIdentityCenterApplicationArn")
201
208
  def attr_identity_center_application_arn(self) -> builtins.str:
202
- '''
209
+ '''The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
210
+
203
211
  :cloudformationAttribute: IdentityCenterApplicationArn
204
212
  '''
205
213
  return typing.cast(builtins.str, jsii.get(self, "attrIdentityCenterApplicationArn"))
@@ -207,7 +215,10 @@ class CfnApplication(
207
215
  @builtins.property
208
216
  @jsii.member(jsii_name="attrStatus")
209
217
  def attr_status(self) -> builtins.str:
210
- '''
218
+ '''The status of the Amazon Q Business application.
219
+
220
+ The application is ready to use when the status is ``ACTIVE`` .
221
+
211
222
  :cloudformationAttribute: Status
212
223
  '''
213
224
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -215,7 +226,8 @@ class CfnApplication(
215
226
  @builtins.property
216
227
  @jsii.member(jsii_name="attrUpdatedAt")
217
228
  def attr_updated_at(self) -> builtins.str:
218
- '''
229
+ '''The Unix timestamp when the Amazon Q Business application was last updated.
230
+
219
231
  :cloudformationAttribute: UpdatedAt
220
232
  '''
221
233
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -234,6 +246,7 @@ class CfnApplication(
234
246
  @builtins.property
235
247
  @jsii.member(jsii_name="displayName")
236
248
  def display_name(self) -> builtins.str:
249
+ '''The name of the Amazon Q Business application.'''
237
250
  return typing.cast(builtins.str, jsii.get(self, "displayName"))
238
251
 
239
252
  @display_name.setter
@@ -248,6 +261,7 @@ class CfnApplication(
248
261
  def attachments_configuration(
249
262
  self,
250
263
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.AttachmentsConfigurationProperty"]]:
264
+ '''Configuration information for the file upload during chat feature.'''
251
265
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.AttachmentsConfigurationProperty"]], jsii.get(self, "attachmentsConfiguration"))
252
266
 
253
267
  @attachments_configuration.setter
@@ -263,6 +277,7 @@ class CfnApplication(
263
277
  @builtins.property
264
278
  @jsii.member(jsii_name="description")
265
279
  def description(self) -> typing.Optional[builtins.str]:
280
+ '''A description for the Amazon Q Business application.'''
266
281
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
267
282
 
268
283
  @description.setter
@@ -277,6 +292,7 @@ class CfnApplication(
277
292
  def encryption_configuration(
278
293
  self,
279
294
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.EncryptionConfigurationProperty"]]:
295
+ '''Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.'''
280
296
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.EncryptionConfigurationProperty"]], jsii.get(self, "encryptionConfiguration"))
281
297
 
282
298
  @encryption_configuration.setter
@@ -292,6 +308,7 @@ class CfnApplication(
292
308
  @builtins.property
293
309
  @jsii.member(jsii_name="identityCenterInstanceArn")
294
310
  def identity_center_instance_arn(self) -> typing.Optional[builtins.str]:
311
+ '''The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.'''
295
312
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "identityCenterInstanceArn"))
296
313
 
297
314
  @identity_center_instance_arn.setter
@@ -307,6 +324,7 @@ class CfnApplication(
307
324
  @builtins.property
308
325
  @jsii.member(jsii_name="roleArn")
309
326
  def role_arn(self) -> typing.Optional[builtins.str]:
327
+ '''The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.'''
310
328
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "roleArn"))
311
329
 
312
330
  @role_arn.setter
@@ -319,6 +337,7 @@ class CfnApplication(
319
337
  @builtins.property
320
338
  @jsii.member(jsii_name="tags")
321
339
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
340
+ '''A list of key-value pairs that identify or categorize your Amazon Q Business application.'''
322
341
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
323
342
 
324
343
  @tags.setter
@@ -335,8 +354,9 @@ class CfnApplication(
335
354
  )
336
355
  class AttachmentsConfigurationProperty:
337
356
  def __init__(self, *, attachments_control_mode: builtins.str) -> None:
338
- '''
339
- :param attachments_control_mode:
357
+ '''Configuration information for the file upload during chat feature.
358
+
359
+ :param attachments_control_mode: Status information about whether file upload functionality is activated or deactivated for your end user.
340
360
 
341
361
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-attachmentsconfiguration.html
342
362
  :exampleMetadata: fixture=_generated
@@ -360,7 +380,8 @@ class CfnApplication(
360
380
 
361
381
  @builtins.property
362
382
  def attachments_control_mode(self) -> builtins.str:
363
- '''
383
+ '''Status information about whether file upload functionality is activated or deactivated for your end user.
384
+
364
385
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-attachmentsconfiguration.html#cfn-qbusiness-application-attachmentsconfiguration-attachmentscontrolmode
365
386
  '''
366
387
  result = self._values.get("attachments_control_mode")
@@ -385,8 +406,11 @@ class CfnApplication(
385
406
  )
386
407
  class EncryptionConfigurationProperty:
387
408
  def __init__(self, *, kms_key_id: typing.Optional[builtins.str] = None) -> None:
388
- '''
389
- :param kms_key_id:
409
+ '''Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
410
+
411
+ Amazon Q Business doesn't support asymmetric keys.
412
+
413
+ :param kms_key_id: The identifier of the AWS KMS key. Amazon Q Business doesn't support asymmetric keys.
390
414
 
391
415
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-encryptionconfiguration.html
392
416
  :exampleMetadata: fixture=_generated
@@ -410,7 +434,10 @@ class CfnApplication(
410
434
 
411
435
  @builtins.property
412
436
  def kms_key_id(self) -> typing.Optional[builtins.str]:
413
- '''
437
+ '''The identifier of the AWS KMS key.
438
+
439
+ Amazon Q Business doesn't support asymmetric keys.
440
+
414
441
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-encryptionconfiguration.html#cfn-qbusiness-application-encryptionconfiguration-kmskeyid
415
442
  '''
416
443
  result = self._values.get("kms_key_id")
@@ -455,13 +482,13 @@ class CfnApplicationProps:
455
482
  ) -> None:
456
483
  '''Properties for defining a ``CfnApplication``.
457
484
 
458
- :param display_name:
459
- :param attachments_configuration:
460
- :param description:
461
- :param encryption_configuration:
462
- :param identity_center_instance_arn:
463
- :param role_arn:
464
- :param tags:
485
+ :param display_name: The name of the Amazon Q Business application.
486
+ :param attachments_configuration: Configuration information for the file upload during chat feature.
487
+ :param description: A description for the Amazon Q Business application.
488
+ :param encryption_configuration: Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
489
+ :param identity_center_instance_arn: The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application. *Required* : ``Yes``
490
+ :param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
491
+ :param tags: A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
465
492
 
466
493
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
467
494
  :exampleMetadata: fixture=_generated
@@ -518,7 +545,8 @@ class CfnApplicationProps:
518
545
 
519
546
  @builtins.property
520
547
  def display_name(self) -> builtins.str:
521
- '''
548
+ '''The name of the Amazon Q Business application.
549
+
522
550
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-displayname
523
551
  '''
524
552
  result = self._values.get("display_name")
@@ -529,7 +557,8 @@ class CfnApplicationProps:
529
557
  def attachments_configuration(
530
558
  self,
531
559
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnApplication.AttachmentsConfigurationProperty]]:
532
- '''
560
+ '''Configuration information for the file upload during chat feature.
561
+
533
562
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-attachmentsconfiguration
534
563
  '''
535
564
  result = self._values.get("attachments_configuration")
@@ -537,7 +566,8 @@ class CfnApplicationProps:
537
566
 
538
567
  @builtins.property
539
568
  def description(self) -> typing.Optional[builtins.str]:
540
- '''
569
+ '''A description for the Amazon Q Business application.
570
+
541
571
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-description
542
572
  '''
543
573
  result = self._values.get("description")
@@ -547,7 +577,10 @@ class CfnApplicationProps:
547
577
  def encryption_configuration(
548
578
  self,
549
579
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnApplication.EncryptionConfigurationProperty]]:
550
- '''
580
+ '''Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
581
+
582
+ Amazon Q Business doesn't support asymmetric keys.
583
+
551
584
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-encryptionconfiguration
552
585
  '''
553
586
  result = self._values.get("encryption_configuration")
@@ -555,7 +588,10 @@ class CfnApplicationProps:
555
588
 
556
589
  @builtins.property
557
590
  def identity_center_instance_arn(self) -> typing.Optional[builtins.str]:
558
- '''
591
+ '''The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
592
+
593
+ *Required* : ``Yes``
594
+
559
595
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitycenterinstancearn
560
596
  '''
561
597
  result = self._values.get("identity_center_instance_arn")
@@ -563,7 +599,8 @@ class CfnApplicationProps:
563
599
 
564
600
  @builtins.property
565
601
  def role_arn(self) -> typing.Optional[builtins.str]:
566
- '''
602
+ '''The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
603
+
567
604
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-rolearn
568
605
  '''
569
606
  result = self._values.get("role_arn")
@@ -571,8 +608,12 @@ class CfnApplicationProps:
571
608
 
572
609
  @builtins.property
573
610
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
574
- '''
611
+ '''A list of key-value pairs that identify or categorize your Amazon Q Business application.
612
+
613
+ You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
614
+
575
615
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-tags
616
+ :: .
576
617
  '''
577
618
  result = self._values.get("tags")
578
619
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
@@ -595,7 +636,9 @@ class CfnDataSource(
595
636
  metaclass=jsii.JSIIMeta,
596
637
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataSource",
597
638
  ):
598
- '''Definition of AWS::QBusiness::DataSource Resource Type.
639
+ '''Creates a data source connector for an Amazon Q Business application.
640
+
641
+ ``CreateDataSource`` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
599
642
 
600
643
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html
601
644
  :cloudformationResource: AWS::QBusiness::DataSource
@@ -712,16 +755,16 @@ class CfnDataSource(
712
755
  '''
713
756
  :param scope: Scope in which this resource is defined.
714
757
  :param id: Construct identifier for this resource (unique in its scope).
715
- :param application_id:
716
- :param configuration:
717
- :param display_name:
718
- :param index_id:
719
- :param description:
720
- :param document_enrichment_configuration:
721
- :param role_arn:
722
- :param sync_schedule:
723
- :param tags:
724
- :param vpc_configuration:
758
+ :param application_id: The identifier of the Amazon Q Business application the data source will be attached to.
759
+ :param configuration: Configuration information to connect to your data source repository. For configuration templates for your specific data source, see `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ .
760
+ :param display_name: The name of the Amazon Q Business data source.
761
+ :param index_id: The identifier of the index the data source is attached to.
762
+ :param description: A description for the data source connector.
763
+ :param document_enrichment_configuration: Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
764
+ :param role_arn: The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
765
+ :param sync_schedule: Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a ``cron-`` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the ``Schedule`` parameter when the ``Type`` parameter is set to ``CUSTOM`` . If you do, you receive a ``ValidationException`` exception.
766
+ :param tags: A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
767
+ :param vpc_configuration: Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see `Using Amazon VPC with Amazon Q Business connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html>`_ .
725
768
  '''
726
769
  if __debug__:
727
770
  type_hints = typing.get_type_hints(_typecheckingstub__44090f525589bca757ae88a29adc87bbfc36c3149c7964dfd32c2ce59b69db58)
@@ -775,7 +818,8 @@ class CfnDataSource(
775
818
  @builtins.property
776
819
  @jsii.member(jsii_name="attrCreatedAt")
777
820
  def attr_created_at(self) -> builtins.str:
778
- '''
821
+ '''The Unix timestamp when the Amazon Q Business data source was created.
822
+
779
823
  :cloudformationAttribute: CreatedAt
780
824
  '''
781
825
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -783,7 +827,8 @@ class CfnDataSource(
783
827
  @builtins.property
784
828
  @jsii.member(jsii_name="attrDataSourceArn")
785
829
  def attr_data_source_arn(self) -> builtins.str:
786
- '''
830
+ '''The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
831
+
787
832
  :cloudformationAttribute: DataSourceArn
788
833
  '''
789
834
  return typing.cast(builtins.str, jsii.get(self, "attrDataSourceArn"))
@@ -791,7 +836,8 @@ class CfnDataSource(
791
836
  @builtins.property
792
837
  @jsii.member(jsii_name="attrDataSourceId")
793
838
  def attr_data_source_id(self) -> builtins.str:
794
- '''
839
+ '''The identifier of the Amazon Q Business data source.
840
+
795
841
  :cloudformationAttribute: DataSourceId
796
842
  '''
797
843
  return typing.cast(builtins.str, jsii.get(self, "attrDataSourceId"))
@@ -799,7 +845,8 @@ class CfnDataSource(
799
845
  @builtins.property
800
846
  @jsii.member(jsii_name="attrStatus")
801
847
  def attr_status(self) -> builtins.str:
802
- '''
848
+ '''The status of the Amazon Q Business data source.
849
+
803
850
  :cloudformationAttribute: Status
804
851
  '''
805
852
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -807,7 +854,8 @@ class CfnDataSource(
807
854
  @builtins.property
808
855
  @jsii.member(jsii_name="attrType")
809
856
  def attr_type(self) -> builtins.str:
810
- '''
857
+ '''The type of the Amazon Q Business data source.
858
+
811
859
  :cloudformationAttribute: Type
812
860
  '''
813
861
  return typing.cast(builtins.str, jsii.get(self, "attrType"))
@@ -815,7 +863,8 @@ class CfnDataSource(
815
863
  @builtins.property
816
864
  @jsii.member(jsii_name="attrUpdatedAt")
817
865
  def attr_updated_at(self) -> builtins.str:
818
- '''
866
+ '''The Unix timestamp when the Amazon Q Business data source was last updated.
867
+
819
868
  :cloudformationAttribute: UpdatedAt
820
869
  '''
821
870
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -834,6 +883,7 @@ class CfnDataSource(
834
883
  @builtins.property
835
884
  @jsii.member(jsii_name="applicationId")
836
885
  def application_id(self) -> builtins.str:
886
+ '''The identifier of the Amazon Q Business application the data source will be attached to.'''
837
887
  return typing.cast(builtins.str, jsii.get(self, "applicationId"))
838
888
 
839
889
  @application_id.setter
@@ -846,6 +896,7 @@ class CfnDataSource(
846
896
  @builtins.property
847
897
  @jsii.member(jsii_name="configuration")
848
898
  def configuration(self) -> typing.Any:
899
+ '''Configuration information to connect to your data source repository.'''
849
900
  return typing.cast(typing.Any, jsii.get(self, "configuration"))
850
901
 
851
902
  @configuration.setter
@@ -858,6 +909,7 @@ class CfnDataSource(
858
909
  @builtins.property
859
910
  @jsii.member(jsii_name="displayName")
860
911
  def display_name(self) -> builtins.str:
912
+ '''The name of the Amazon Q Business data source.'''
861
913
  return typing.cast(builtins.str, jsii.get(self, "displayName"))
862
914
 
863
915
  @display_name.setter
@@ -870,6 +922,7 @@ class CfnDataSource(
870
922
  @builtins.property
871
923
  @jsii.member(jsii_name="indexId")
872
924
  def index_id(self) -> builtins.str:
925
+ '''The identifier of the index the data source is attached to.'''
873
926
  return typing.cast(builtins.str, jsii.get(self, "indexId"))
874
927
 
875
928
  @index_id.setter
@@ -882,6 +935,7 @@ class CfnDataSource(
882
935
  @builtins.property
883
936
  @jsii.member(jsii_name="description")
884
937
  def description(self) -> typing.Optional[builtins.str]:
938
+ '''A description for the data source connector.'''
885
939
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
886
940
 
887
941
  @description.setter
@@ -896,6 +950,7 @@ class CfnDataSource(
896
950
  def document_enrichment_configuration(
897
951
  self,
898
952
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentEnrichmentConfigurationProperty"]]:
953
+ '''Provides the configuration information for altering document metadata and content during the document ingestion process.'''
899
954
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentEnrichmentConfigurationProperty"]], jsii.get(self, "documentEnrichmentConfiguration"))
900
955
 
901
956
  @document_enrichment_configuration.setter
@@ -911,6 +966,7 @@ class CfnDataSource(
911
966
  @builtins.property
912
967
  @jsii.member(jsii_name="roleArn")
913
968
  def role_arn(self) -> typing.Optional[builtins.str]:
969
+ '''The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.'''
914
970
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "roleArn"))
915
971
 
916
972
  @role_arn.setter
@@ -923,6 +979,7 @@ class CfnDataSource(
923
979
  @builtins.property
924
980
  @jsii.member(jsii_name="syncSchedule")
925
981
  def sync_schedule(self) -> typing.Optional[builtins.str]:
982
+ '''Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.'''
926
983
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "syncSchedule"))
927
984
 
928
985
  @sync_schedule.setter
@@ -935,6 +992,7 @@ class CfnDataSource(
935
992
  @builtins.property
936
993
  @jsii.member(jsii_name="tags")
937
994
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
995
+ '''A list of key-value pairs that identify or categorize the data source connector.'''
938
996
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
939
997
 
940
998
  @tags.setter
@@ -949,6 +1007,7 @@ class CfnDataSource(
949
1007
  def vpc_configuration(
950
1008
  self,
951
1009
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceVpcConfigurationProperty"]]:
1010
+ '''Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.'''
952
1011
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DataSourceVpcConfigurationProperty"]], jsii.get(self, "vpcConfiguration"))
953
1012
 
954
1013
  @vpc_configuration.setter
@@ -976,9 +1035,10 @@ class CfnDataSource(
976
1035
  security_group_ids: typing.Sequence[builtins.str],
977
1036
  subnet_ids: typing.Sequence[builtins.str],
978
1037
  ) -> None:
979
- '''
980
- :param security_group_ids:
981
- :param subnet_ids:
1038
+ '''Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
1039
+
1040
+ :param security_group_ids: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
1041
+ :param subnet_ids: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
982
1042
 
983
1043
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html
984
1044
  :exampleMetadata: fixture=_generated
@@ -1005,7 +1065,10 @@ class CfnDataSource(
1005
1065
 
1006
1066
  @builtins.property
1007
1067
  def security_group_ids(self) -> typing.List[builtins.str]:
1008
- '''
1068
+ '''A list of identifiers of security groups within your Amazon VPC.
1069
+
1070
+ The security groups should enable Amazon Q Business to connect to the data source.
1071
+
1009
1072
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-securitygroupids
1010
1073
  '''
1011
1074
  result = self._values.get("security_group_ids")
@@ -1014,7 +1077,10 @@ class CfnDataSource(
1014
1077
 
1015
1078
  @builtins.property
1016
1079
  def subnet_ids(self) -> typing.List[builtins.str]:
1017
- '''
1080
+ '''A list of identifiers for subnets within your Amazon VPC.
1081
+
1082
+ The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
1083
+
1018
1084
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-datasourcevpcconfiguration.html#cfn-qbusiness-datasource-datasourcevpcconfiguration-subnetids
1019
1085
  '''
1020
1086
  result = self._values.get("subnet_ids")
@@ -1045,10 +1111,17 @@ class CfnDataSource(
1045
1111
  operator: builtins.str,
1046
1112
  value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.DocumentAttributeValueProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1047
1113
  ) -> None:
1048
- '''
1049
- :param key:
1050
- :param operator:
1051
- :param value:
1114
+ '''The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.
1115
+
1116
+ You use this with ```DocumentAttributeTarget`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html>`_ to apply the condition.
1117
+
1118
+ For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
1119
+
1120
+ Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using ``DocumentAttributeTarget`` . Amazon Q Business then will map your newly created metadata field to your index field.
1121
+
1122
+ :param key: The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn't support ``_document_body`` as an attribute key used for the condition.
1123
+ :param operator: The identifier of the document attribute used for the condition. For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support ``_document_body`` as an attribute key used for the condition.
1124
+ :param value: The value of a document attribute. You can only provide one value for a document attribute.
1052
1125
 
1053
1126
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html
1054
1127
  :exampleMetadata: fixture=_generated
@@ -1086,7 +1159,12 @@ class CfnDataSource(
1086
1159
 
1087
1160
  @builtins.property
1088
1161
  def key(self) -> builtins.str:
1089
- '''
1162
+ '''The identifier of the document attribute used for the condition.
1163
+
1164
+ For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
1165
+
1166
+ Amazon Q Business currently doesn't support ``_document_body`` as an attribute key used for the condition.
1167
+
1090
1168
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-key
1091
1169
  '''
1092
1170
  result = self._values.get("key")
@@ -1095,7 +1173,12 @@ class CfnDataSource(
1095
1173
 
1096
1174
  @builtins.property
1097
1175
  def operator(self) -> builtins.str:
1098
- '''
1176
+ '''The identifier of the document attribute used for the condition.
1177
+
1178
+ For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
1179
+
1180
+ Amazon Q Business currently does not support ``_document_body`` as an attribute key used for the condition.
1181
+
1099
1182
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-operator
1100
1183
  '''
1101
1184
  result = self._values.get("operator")
@@ -1106,7 +1189,10 @@ class CfnDataSource(
1106
1189
  def value(
1107
1190
  self,
1108
1191
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentAttributeValueProperty"]]:
1109
- '''
1192
+ '''The value of a document attribute.
1193
+
1194
+ You can only provide one value for a document attribute.
1195
+
1110
1196
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributecondition.html#cfn-qbusiness-datasource-documentattributecondition-value
1111
1197
  '''
1112
1198
  result = self._values.get("value")
@@ -1140,10 +1226,17 @@ class CfnDataSource(
1140
1226
  attribute_value_operator: typing.Optional[builtins.str] = None,
1141
1227
  value: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.DocumentAttributeValueProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1142
1228
  ) -> None:
1143
- '''
1144
- :param key:
1145
- :param attribute_value_operator:
1146
- :param value:
1229
+ '''The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
1230
+
1231
+ For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to ``TRUE`` . This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
1232
+
1233
+ Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using ```DocumentAttributeTarget`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html>`_ . Amazon Q Business will then map your newly created document attribute to your index field.
1234
+
1235
+ You can also use this with ```DocumentAttributeCondition`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html>`_ .
1236
+
1237
+ :param key: The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
1238
+ :param attribute_value_operator: ``TRUE`` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to ``TRUE`` .
1239
+ :param value: The value of a document attribute. You can only provide one value for a document attribute.
1147
1240
 
1148
1241
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html
1149
1242
  :exampleMetadata: fixture=_generated
@@ -1182,7 +1275,10 @@ class CfnDataSource(
1182
1275
 
1183
1276
  @builtins.property
1184
1277
  def key(self) -> builtins.str:
1185
- '''
1278
+ '''The identifier of the target document attribute or metadata field.
1279
+
1280
+ For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
1281
+
1186
1282
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-key
1187
1283
  '''
1188
1284
  result = self._values.get("key")
@@ -1191,7 +1287,10 @@ class CfnDataSource(
1191
1287
 
1192
1288
  @builtins.property
1193
1289
  def attribute_value_operator(self) -> typing.Optional[builtins.str]:
1194
- '''
1290
+ '''``TRUE`` to delete the existing target value for your specified target attribute key.
1291
+
1292
+ You cannot create a target value and set this to ``TRUE`` .
1293
+
1195
1294
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-attributevalueoperator
1196
1295
  '''
1197
1296
  result = self._values.get("attribute_value_operator")
@@ -1201,7 +1300,10 @@ class CfnDataSource(
1201
1300
  def value(
1202
1301
  self,
1203
1302
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentAttributeValueProperty"]]:
1204
- '''
1303
+ '''The value of a document attribute.
1304
+
1305
+ You can only provide one value for a document attribute.
1306
+
1205
1307
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributetarget.html#cfn-qbusiness-datasource-documentattributetarget-value
1206
1308
  '''
1207
1309
  result = self._values.get("value")
@@ -1237,11 +1339,14 @@ class CfnDataSource(
1237
1339
  string_list_value: typing.Optional[typing.Sequence[builtins.str]] = None,
1238
1340
  string_value: typing.Optional[builtins.str] = None,
1239
1341
  ) -> None:
1240
- '''
1241
- :param date_value:
1242
- :param long_value:
1243
- :param string_list_value:
1244
- :param string_value:
1342
+ '''The value of a document attribute.
1343
+
1344
+ You can only provide one value for a document attribute.
1345
+
1346
+ :param date_value: A date expressed as an ISO 8601 string. It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
1347
+ :param long_value: A long integer value.
1348
+ :param string_list_value: A list of strings.
1349
+ :param string_value: A string.
1245
1350
 
1246
1351
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html
1247
1352
  :exampleMetadata: fixture=_generated
@@ -1277,7 +1382,10 @@ class CfnDataSource(
1277
1382
 
1278
1383
  @builtins.property
1279
1384
  def date_value(self) -> typing.Optional[builtins.str]:
1280
- '''
1385
+ '''A date expressed as an ISO 8601 string.
1386
+
1387
+ It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
1388
+
1281
1389
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-datevalue
1282
1390
  '''
1283
1391
  result = self._values.get("date_value")
@@ -1285,7 +1393,8 @@ class CfnDataSource(
1285
1393
 
1286
1394
  @builtins.property
1287
1395
  def long_value(self) -> typing.Optional[jsii.Number]:
1288
- '''
1396
+ '''A long integer value.
1397
+
1289
1398
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-longvalue
1290
1399
  '''
1291
1400
  result = self._values.get("long_value")
@@ -1293,7 +1402,8 @@ class CfnDataSource(
1293
1402
 
1294
1403
  @builtins.property
1295
1404
  def string_list_value(self) -> typing.Optional[typing.List[builtins.str]]:
1296
- '''
1405
+ '''A list of strings.
1406
+
1297
1407
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-stringlistvalue
1298
1408
  '''
1299
1409
  result = self._values.get("string_list_value")
@@ -1301,7 +1411,8 @@ class CfnDataSource(
1301
1411
 
1302
1412
  @builtins.property
1303
1413
  def string_value(self) -> typing.Optional[builtins.str]:
1304
- '''
1414
+ '''A string.
1415
+
1305
1416
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentattributevalue.html#cfn-qbusiness-datasource-documentattributevalue-stringvalue
1306
1417
  '''
1307
1418
  result = self._values.get("string_value")
@@ -1335,10 +1446,13 @@ class CfnDataSource(
1335
1446
  post_extraction_hook_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.HookConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1336
1447
  pre_extraction_hook_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.HookConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1337
1448
  ) -> None:
1338
- '''
1339
- :param inline_configurations:
1340
- :param post_extraction_hook_configuration:
1341
- :param pre_extraction_hook_configuration:
1449
+ '''Provides the configuration information for altering document metadata and content during the document ingestion process.
1450
+
1451
+ For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
1452
+
1453
+ :param inline_configurations: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
1454
+ :param post_extraction_hook_configuration: Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see `Using Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html>`_ .
1455
+ :param pre_extraction_hook_configuration: Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see `Using Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html>`_ .
1342
1456
 
1343
1457
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html
1344
1458
  :exampleMetadata: fixture=_generated
@@ -1430,7 +1544,8 @@ class CfnDataSource(
1430
1544
  def inline_configurations(
1431
1545
  self,
1432
1546
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataSource.InlineDocumentEnrichmentConfigurationProperty"]]]]:
1433
- '''
1547
+ '''Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
1548
+
1434
1549
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-inlineconfigurations
1435
1550
  '''
1436
1551
  result = self._values.get("inline_configurations")
@@ -1440,7 +1555,10 @@ class CfnDataSource(
1440
1555
  def post_extraction_hook_configuration(
1441
1556
  self,
1442
1557
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.HookConfigurationProperty"]]:
1443
- '''
1558
+ '''Configuration information for invoking a Lambda function in AWS Lambda on the structured documents with their metadata and text extracted.
1559
+
1560
+ You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see `Using Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html>`_ .
1561
+
1444
1562
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-postextractionhookconfiguration
1445
1563
  '''
1446
1564
  result = self._values.get("post_extraction_hook_configuration")
@@ -1450,7 +1568,10 @@ class CfnDataSource(
1450
1568
  def pre_extraction_hook_configuration(
1451
1569
  self,
1452
1570
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.HookConfigurationProperty"]]:
1453
- '''
1571
+ '''Configuration information for invoking a Lambda function in AWS Lambda on the original or raw documents before extracting their metadata and text.
1572
+
1573
+ You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see `Using Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html>`_ .
1574
+
1454
1575
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-documentenrichmentconfiguration.html#cfn-qbusiness-datasource-documentenrichmentconfiguration-preextractionhookconfiguration
1455
1576
  '''
1456
1577
  result = self._values.get("pre_extraction_hook_configuration")
@@ -1486,11 +1607,20 @@ class CfnDataSource(
1486
1607
  role_arn: typing.Optional[builtins.str] = None,
1487
1608
  s3_bucket_name: typing.Optional[builtins.str] = None,
1488
1609
  ) -> None:
1489
- '''
1490
- :param invocation_condition:
1491
- :param lambda_arn:
1492
- :param role_arn:
1493
- :param s3_bucket_name:
1610
+ '''Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
1611
+
1612
+ You can configure your Lambda function using the ``PreExtractionHookConfiguration`` parameter if you want to apply advanced alterations on the original or raw documents.
1613
+
1614
+ If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using ``PostExtractionHookConfiguration`` .
1615
+
1616
+ You can only invoke one Lambda function. However, this function can invoke other functions it requires.
1617
+
1618
+ For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
1619
+
1620
+ :param invocation_condition: The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
1621
+ :param lambda_arn: The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see `IAM roles for Custom Document Enrichment (CDE) <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role>`_ .
1622
+ :param role_arn: The Amazon Resource Name (ARN) of a role with permission to run ``PreExtractionHookConfiguration`` and ``PostExtractionHookConfiguration`` for altering document metadata and content during the document ingestion process.
1623
+ :param s3_bucket_name: Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see `Data contracts for Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts>`_ .
1494
1624
 
1495
1625
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html
1496
1626
  :exampleMetadata: fixture=_generated
@@ -1539,7 +1669,10 @@ class CfnDataSource(
1539
1669
  def invocation_condition(
1540
1670
  self,
1541
1671
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentAttributeConditionProperty"]]:
1542
- '''
1672
+ '''The condition used for when a Lambda function should be invoked.
1673
+
1674
+ For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
1675
+
1543
1676
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-invocationcondition
1544
1677
  '''
1545
1678
  result = self._values.get("invocation_condition")
@@ -1547,7 +1680,10 @@ class CfnDataSource(
1547
1680
 
1548
1681
  @builtins.property
1549
1682
  def lambda_arn(self) -> typing.Optional[builtins.str]:
1550
- '''
1683
+ '''The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
1684
+
1685
+ For more information, see `IAM roles for Custom Document Enrichment (CDE) <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role>`_ .
1686
+
1551
1687
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-lambdaarn
1552
1688
  '''
1553
1689
  result = self._values.get("lambda_arn")
@@ -1555,7 +1691,8 @@ class CfnDataSource(
1555
1691
 
1556
1692
  @builtins.property
1557
1693
  def role_arn(self) -> typing.Optional[builtins.str]:
1558
- '''
1694
+ '''The Amazon Resource Name (ARN) of a role with permission to run ``PreExtractionHookConfiguration`` and ``PostExtractionHookConfiguration`` for altering document metadata and content during the document ingestion process.
1695
+
1559
1696
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-rolearn
1560
1697
  '''
1561
1698
  result = self._values.get("role_arn")
@@ -1563,7 +1700,10 @@ class CfnDataSource(
1563
1700
 
1564
1701
  @builtins.property
1565
1702
  def s3_bucket_name(self) -> typing.Optional[builtins.str]:
1566
- '''
1703
+ '''Stores the original, raw documents or the structured, parsed documents before and after altering them.
1704
+
1705
+ For more information, see `Data contracts for Lambda functions <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts>`_ .
1706
+
1567
1707
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-hookconfiguration.html#cfn-qbusiness-datasource-hookconfiguration-s3bucketname
1568
1708
  '''
1569
1709
  result = self._values.get("s3_bucket_name")
@@ -1597,10 +1737,15 @@ class CfnDataSource(
1597
1737
  document_content_operator: typing.Optional[builtins.str] = None,
1598
1738
  target: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.DocumentAttributeTargetProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1599
1739
  ) -> None:
1600
- '''
1601
- :param condition:
1602
- :param document_content_operator:
1603
- :param target:
1740
+ '''Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
1741
+
1742
+ To apply advanced logic, to go beyond what you can do with basic logic, see ```HookConfiguration`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html>`_ .
1743
+
1744
+ For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
1745
+
1746
+ :param condition: Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
1747
+ :param document_content_operator: ``TRUE`` to delete content if the condition used for the target attribute is met.
1748
+ :param target: Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business . You can also include a value.
1604
1749
 
1605
1750
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html
1606
1751
  :exampleMetadata: fixture=_generated
@@ -1656,7 +1801,8 @@ class CfnDataSource(
1656
1801
  def condition(
1657
1802
  self,
1658
1803
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentAttributeConditionProperty"]]:
1659
- '''
1804
+ '''Configuration of the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business .
1805
+
1660
1806
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-condition
1661
1807
  '''
1662
1808
  result = self._values.get("condition")
@@ -1664,7 +1810,8 @@ class CfnDataSource(
1664
1810
 
1665
1811
  @builtins.property
1666
1812
  def document_content_operator(self) -> typing.Optional[builtins.str]:
1667
- '''
1813
+ '''``TRUE`` to delete content if the condition used for the target attribute is met.
1814
+
1668
1815
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-documentcontentoperator
1669
1816
  '''
1670
1817
  result = self._values.get("document_content_operator")
@@ -1674,7 +1821,10 @@ class CfnDataSource(
1674
1821
  def target(
1675
1822
  self,
1676
1823
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.DocumentAttributeTargetProperty"]]:
1677
- '''
1824
+ '''Configuration of the target document attribute or metadata field when ingesting documents into Amazon Q Business .
1825
+
1826
+ You can also include a value.
1827
+
1678
1828
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-inlinedocumentenrichmentconfiguration.html#cfn-qbusiness-datasource-inlinedocumentenrichmentconfiguration-target
1679
1829
  '''
1680
1830
  result = self._values.get("target")
@@ -1725,16 +1875,16 @@ class CfnDataSourceProps:
1725
1875
  ) -> None:
1726
1876
  '''Properties for defining a ``CfnDataSource``.
1727
1877
 
1728
- :param application_id:
1729
- :param configuration:
1730
- :param display_name:
1731
- :param index_id:
1732
- :param description:
1733
- :param document_enrichment_configuration:
1734
- :param role_arn:
1735
- :param sync_schedule:
1736
- :param tags:
1737
- :param vpc_configuration:
1878
+ :param application_id: The identifier of the Amazon Q Business application the data source will be attached to.
1879
+ :param configuration: Configuration information to connect to your data source repository. For configuration templates for your specific data source, see `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ .
1880
+ :param display_name: The name of the Amazon Q Business data source.
1881
+ :param index_id: The identifier of the index the data source is attached to.
1882
+ :param description: A description for the data source connector.
1883
+ :param document_enrichment_configuration: Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
1884
+ :param role_arn: The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
1885
+ :param sync_schedule: Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a ``cron-`` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the ``Schedule`` parameter when the ``Type`` parameter is set to ``CUSTOM`` . If you do, you receive a ``ValidationException`` exception.
1886
+ :param tags: A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
1887
+ :param vpc_configuration: Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see `Using Amazon VPC with Amazon Q Business connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html>`_ .
1738
1888
 
1739
1889
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html
1740
1890
  :exampleMetadata: fixture=_generated
@@ -1863,7 +2013,8 @@ class CfnDataSourceProps:
1863
2013
 
1864
2014
  @builtins.property
1865
2015
  def application_id(self) -> builtins.str:
1866
- '''
2016
+ '''The identifier of the Amazon Q Business application the data source will be attached to.
2017
+
1867
2018
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-applicationid
1868
2019
  '''
1869
2020
  result = self._values.get("application_id")
@@ -1872,7 +2023,10 @@ class CfnDataSourceProps:
1872
2023
 
1873
2024
  @builtins.property
1874
2025
  def configuration(self) -> typing.Any:
1875
- '''
2026
+ '''Configuration information to connect to your data source repository.
2027
+
2028
+ For configuration templates for your specific data source, see `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ .
2029
+
1876
2030
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-configuration
1877
2031
  '''
1878
2032
  result = self._values.get("configuration")
@@ -1881,7 +2035,8 @@ class CfnDataSourceProps:
1881
2035
 
1882
2036
  @builtins.property
1883
2037
  def display_name(self) -> builtins.str:
1884
- '''
2038
+ '''The name of the Amazon Q Business data source.
2039
+
1885
2040
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-displayname
1886
2041
  '''
1887
2042
  result = self._values.get("display_name")
@@ -1890,7 +2045,8 @@ class CfnDataSourceProps:
1890
2045
 
1891
2046
  @builtins.property
1892
2047
  def index_id(self) -> builtins.str:
1893
- '''
2048
+ '''The identifier of the index the data source is attached to.
2049
+
1894
2050
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-indexid
1895
2051
  '''
1896
2052
  result = self._values.get("index_id")
@@ -1899,7 +2055,8 @@ class CfnDataSourceProps:
1899
2055
 
1900
2056
  @builtins.property
1901
2057
  def description(self) -> typing.Optional[builtins.str]:
1902
- '''
2058
+ '''A description for the data source connector.
2059
+
1903
2060
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-description
1904
2061
  '''
1905
2062
  result = self._values.get("description")
@@ -1909,7 +2066,10 @@ class CfnDataSourceProps:
1909
2066
  def document_enrichment_configuration(
1910
2067
  self,
1911
2068
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.DocumentEnrichmentConfigurationProperty]]:
1912
- '''
2069
+ '''Provides the configuration information for altering document metadata and content during the document ingestion process.
2070
+
2071
+ For more information, see `Custom document enrichment <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html>`_ .
2072
+
1913
2073
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-documentenrichmentconfiguration
1914
2074
  '''
1915
2075
  result = self._values.get("document_enrichment_configuration")
@@ -1917,7 +2077,8 @@ class CfnDataSourceProps:
1917
2077
 
1918
2078
  @builtins.property
1919
2079
  def role_arn(self) -> typing.Optional[builtins.str]:
1920
- '''
2080
+ '''The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
2081
+
1921
2082
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-rolearn
1922
2083
  '''
1923
2084
  result = self._values.get("role_arn")
@@ -1925,7 +2086,12 @@ class CfnDataSourceProps:
1925
2086
 
1926
2087
  @builtins.property
1927
2088
  def sync_schedule(self) -> typing.Optional[builtins.str]:
1928
- '''
2089
+ '''Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.
2090
+
2091
+ If you don't set a schedule, Amazon Q Business won't periodically update the index.
2092
+
2093
+ Specify a ``cron-`` format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the ``Schedule`` parameter when the ``Type`` parameter is set to ``CUSTOM`` . If you do, you receive a ``ValidationException`` exception.
2094
+
1929
2095
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-syncschedule
1930
2096
  '''
1931
2097
  result = self._values.get("sync_schedule")
@@ -1933,8 +2099,12 @@ class CfnDataSourceProps:
1933
2099
 
1934
2100
  @builtins.property
1935
2101
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
1936
- '''
2102
+ '''A list of key-value pairs that identify or categorize the data source connector.
2103
+
2104
+ You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
2105
+
1937
2106
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-tags
2107
+ :: .
1938
2108
  '''
1939
2109
  result = self._values.get("tags")
1940
2110
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
@@ -1943,7 +2113,10 @@ class CfnDataSourceProps:
1943
2113
  def vpc_configuration(
1944
2114
  self,
1945
2115
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.DataSourceVpcConfigurationProperty]]:
1946
- '''
2116
+ '''Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
2117
+
2118
+ For more information, see `Using Amazon VPC with Amazon Q Business connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html>`_ .
2119
+
1947
2120
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-vpcconfiguration
1948
2121
  '''
1949
2122
  result = self._values.get("vpc_configuration")
@@ -1967,7 +2140,11 @@ class CfnIndex(
1967
2140
  metaclass=jsii.JSIIMeta,
1968
2141
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnIndex",
1969
2142
  ):
1970
- '''Definition of AWS::QBusiness::Index Resource Type.
2143
+ '''Creates an Amazon Q Business index.
2144
+
2145
+ To determine if index creation has completed, check the ``Status`` field returned from a call to ``DescribeIndex`` . The ``Status`` field is set to ``ACTIVE`` when the index is ready to use.
2146
+
2147
+ Once the index is active, you can index your documents using the ```BatchPutDocument`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html>`_ API or the ```CreateDataSource`` <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html>`_ API.
1971
2148
 
1972
2149
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html
1973
2150
  :cloudformationResource: AWS::QBusiness::Index
@@ -2017,13 +2194,13 @@ class CfnIndex(
2017
2194
  '''
2018
2195
  :param scope: Scope in which this resource is defined.
2019
2196
  :param id: Construct identifier for this resource (unique in its scope).
2020
- :param application_id:
2021
- :param display_name:
2022
- :param capacity_configuration:
2023
- :param description:
2024
- :param document_attribute_configurations:
2025
- :param tags:
2026
- :param type:
2197
+ :param application_id: The identifier of the Amazon Q Business application using the index.
2198
+ :param display_name: The name of the index.
2199
+ :param capacity_configuration: The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
2200
+ :param description: A description for the Amazon Q Business index.
2201
+ :param document_attribute_configurations: Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html>`_ .
2202
+ :param tags: A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
2203
+ :param type: The index type that's suitable for your needs. For more information on what's included in each type of index, see `Amazon Q Business tiers <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers>`_ .
2027
2204
  '''
2028
2205
  if __debug__:
2029
2206
  type_hints = typing.get_type_hints(_typecheckingstub__c457625f955b1ba56d35bffbcea827abe87347b80fd33090422ef2a8092cd10e)
@@ -2074,7 +2251,8 @@ class CfnIndex(
2074
2251
  @builtins.property
2075
2252
  @jsii.member(jsii_name="attrCreatedAt")
2076
2253
  def attr_created_at(self) -> builtins.str:
2077
- '''
2254
+ '''The Unix timestamp when the index was created.
2255
+
2078
2256
  :cloudformationAttribute: CreatedAt
2079
2257
  '''
2080
2258
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -2082,7 +2260,8 @@ class CfnIndex(
2082
2260
  @builtins.property
2083
2261
  @jsii.member(jsii_name="attrIndexArn")
2084
2262
  def attr_index_arn(self) -> builtins.str:
2085
- '''
2263
+ '''The Amazon Resource Name (ARN) of an Amazon Q Business index.
2264
+
2086
2265
  :cloudformationAttribute: IndexArn
2087
2266
  '''
2088
2267
  return typing.cast(builtins.str, jsii.get(self, "attrIndexArn"))
@@ -2090,7 +2269,8 @@ class CfnIndex(
2090
2269
  @builtins.property
2091
2270
  @jsii.member(jsii_name="attrIndexId")
2092
2271
  def attr_index_id(self) -> builtins.str:
2093
- '''
2272
+ '''The identifier for the index.
2273
+
2094
2274
  :cloudformationAttribute: IndexId
2095
2275
  '''
2096
2276
  return typing.cast(builtins.str, jsii.get(self, "attrIndexId"))
@@ -2106,7 +2286,10 @@ class CfnIndex(
2106
2286
  @builtins.property
2107
2287
  @jsii.member(jsii_name="attrStatus")
2108
2288
  def attr_status(self) -> builtins.str:
2109
- '''
2289
+ '''The current status of the index.
2290
+
2291
+ When the status is ``ACTIVE`` , the index is ready.
2292
+
2110
2293
  :cloudformationAttribute: Status
2111
2294
  '''
2112
2295
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -2114,7 +2297,8 @@ class CfnIndex(
2114
2297
  @builtins.property
2115
2298
  @jsii.member(jsii_name="attrUpdatedAt")
2116
2299
  def attr_updated_at(self) -> builtins.str:
2117
- '''
2300
+ '''The Unix timestamp when the index was last updated.
2301
+
2118
2302
  :cloudformationAttribute: UpdatedAt
2119
2303
  '''
2120
2304
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -2133,6 +2317,7 @@ class CfnIndex(
2133
2317
  @builtins.property
2134
2318
  @jsii.member(jsii_name="applicationId")
2135
2319
  def application_id(self) -> builtins.str:
2320
+ '''The identifier of the Amazon Q Business application using the index.'''
2136
2321
  return typing.cast(builtins.str, jsii.get(self, "applicationId"))
2137
2322
 
2138
2323
  @application_id.setter
@@ -2145,6 +2330,7 @@ class CfnIndex(
2145
2330
  @builtins.property
2146
2331
  @jsii.member(jsii_name="displayName")
2147
2332
  def display_name(self) -> builtins.str:
2333
+ '''The name of the index.'''
2148
2334
  return typing.cast(builtins.str, jsii.get(self, "displayName"))
2149
2335
 
2150
2336
  @display_name.setter
@@ -2159,6 +2345,7 @@ class CfnIndex(
2159
2345
  def capacity_configuration(
2160
2346
  self,
2161
2347
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnIndex.IndexCapacityConfigurationProperty"]]:
2348
+ '''The capacity units you want to provision for your index.'''
2162
2349
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnIndex.IndexCapacityConfigurationProperty"]], jsii.get(self, "capacityConfiguration"))
2163
2350
 
2164
2351
  @capacity_configuration.setter
@@ -2174,6 +2361,7 @@ class CfnIndex(
2174
2361
  @builtins.property
2175
2362
  @jsii.member(jsii_name="description")
2176
2363
  def description(self) -> typing.Optional[builtins.str]:
2364
+ '''A description for the Amazon Q Business index.'''
2177
2365
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
2178
2366
 
2179
2367
  @description.setter
@@ -2188,6 +2376,7 @@ class CfnIndex(
2188
2376
  def document_attribute_configurations(
2189
2377
  self,
2190
2378
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnIndex.DocumentAttributeConfigurationProperty"]]]]:
2379
+ '''Configuration information for document attributes.'''
2191
2380
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnIndex.DocumentAttributeConfigurationProperty"]]]], jsii.get(self, "documentAttributeConfigurations"))
2192
2381
 
2193
2382
  @document_attribute_configurations.setter
@@ -2203,6 +2392,7 @@ class CfnIndex(
2203
2392
  @builtins.property
2204
2393
  @jsii.member(jsii_name="tags")
2205
2394
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
2395
+ '''A list of key-value pairs that identify or categorize the index.'''
2206
2396
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
2207
2397
 
2208
2398
  @tags.setter
@@ -2215,6 +2405,7 @@ class CfnIndex(
2215
2405
  @builtins.property
2216
2406
  @jsii.member(jsii_name="type")
2217
2407
  def type(self) -> typing.Optional[builtins.str]:
2408
+ '''The index type that's suitable for your needs.'''
2218
2409
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "type"))
2219
2410
 
2220
2411
  @type.setter
@@ -2237,10 +2428,15 @@ class CfnIndex(
2237
2428
  search: typing.Optional[builtins.str] = None,
2238
2429
  type: typing.Optional[builtins.str] = None,
2239
2430
  ) -> None:
2240
- '''
2241
- :param name:
2242
- :param search:
2243
- :param type:
2431
+ '''Configuration information for document attributes.
2432
+
2433
+ Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
2434
+
2435
+ For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html>`_ .
2436
+
2437
+ :param name: The name of the document attribute.
2438
+ :param search: Information about whether the document attribute can be used by an end user to search for information on their web experience.
2439
+ :param type: The type of document attribute.
2244
2440
 
2245
2441
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html
2246
2442
  :exampleMetadata: fixture=_generated
@@ -2272,7 +2468,8 @@ class CfnIndex(
2272
2468
 
2273
2469
  @builtins.property
2274
2470
  def name(self) -> typing.Optional[builtins.str]:
2275
- '''
2471
+ '''The name of the document attribute.
2472
+
2276
2473
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-name
2277
2474
  '''
2278
2475
  result = self._values.get("name")
@@ -2280,7 +2477,8 @@ class CfnIndex(
2280
2477
 
2281
2478
  @builtins.property
2282
2479
  def search(self) -> typing.Optional[builtins.str]:
2283
- '''
2480
+ '''Information about whether the document attribute can be used by an end user to search for information on their web experience.
2481
+
2284
2482
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-search
2285
2483
  '''
2286
2484
  result = self._values.get("search")
@@ -2288,7 +2486,8 @@ class CfnIndex(
2288
2486
 
2289
2487
  @builtins.property
2290
2488
  def type(self) -> typing.Optional[builtins.str]:
2291
- '''
2489
+ '''The type of document attribute.
2490
+
2292
2491
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-documentattributeconfiguration.html#cfn-qbusiness-index-documentattributeconfiguration-type
2293
2492
  '''
2294
2493
  result = self._values.get("type")
@@ -2312,8 +2511,9 @@ class CfnIndex(
2312
2511
  )
2313
2512
  class IndexCapacityConfigurationProperty:
2314
2513
  def __init__(self, *, units: typing.Optional[jsii.Number] = None) -> None:
2315
- '''
2316
- :param units:
2514
+ '''Provides information about index capacity configuration.
2515
+
2516
+ :param units: The number of storage units configured for an Amazon Q Business index.
2317
2517
 
2318
2518
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.html
2319
2519
  :exampleMetadata: fixture=_generated
@@ -2337,7 +2537,8 @@ class CfnIndex(
2337
2537
 
2338
2538
  @builtins.property
2339
2539
  def units(self) -> typing.Optional[jsii.Number]:
2340
- '''
2540
+ '''The number of storage units configured for an Amazon Q Business index.
2541
+
2341
2542
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexcapacityconfiguration.html#cfn-qbusiness-index-indexcapacityconfiguration-units
2342
2543
  '''
2343
2544
  result = self._values.get("units")
@@ -2365,8 +2566,9 @@ class CfnIndex(
2365
2566
  *,
2366
2567
  text_document_statistics: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnIndex.TextDocumentStatisticsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
2367
2568
  ) -> None:
2368
- '''
2369
- :param text_document_statistics:
2569
+ '''Provides information about the number of documents in an index.
2570
+
2571
+ :param text_document_statistics: The number of documents indexed.
2370
2572
 
2371
2573
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexstatistics.html
2372
2574
  :exampleMetadata: fixture=_generated
@@ -2395,7 +2597,8 @@ class CfnIndex(
2395
2597
  def text_document_statistics(
2396
2598
  self,
2397
2599
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnIndex.TextDocumentStatisticsProperty"]]:
2398
- '''
2600
+ '''The number of documents indexed.
2601
+
2399
2602
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-indexstatistics.html#cfn-qbusiness-index-indexstatistics-textdocumentstatistics
2400
2603
  '''
2401
2604
  result = self._values.get("text_document_statistics")
@@ -2427,9 +2630,10 @@ class CfnIndex(
2427
2630
  indexed_text_bytes: typing.Optional[jsii.Number] = None,
2428
2631
  indexed_text_document_count: typing.Optional[jsii.Number] = None,
2429
2632
  ) -> None:
2430
- '''
2431
- :param indexed_text_bytes:
2432
- :param indexed_text_document_count:
2633
+ '''Provides information about text documents in an index.
2634
+
2635
+ :param indexed_text_bytes: The total size, in bytes, of the indexed documents.
2636
+ :param indexed_text_document_count: The number of text documents indexed.
2433
2637
 
2434
2638
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html
2435
2639
  :exampleMetadata: fixture=_generated
@@ -2457,7 +2661,8 @@ class CfnIndex(
2457
2661
 
2458
2662
  @builtins.property
2459
2663
  def indexed_text_bytes(self) -> typing.Optional[jsii.Number]:
2460
- '''
2664
+ '''The total size, in bytes, of the indexed documents.
2665
+
2461
2666
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html#cfn-qbusiness-index-textdocumentstatistics-indexedtextbytes
2462
2667
  '''
2463
2668
  result = self._values.get("indexed_text_bytes")
@@ -2465,7 +2670,8 @@ class CfnIndex(
2465
2670
 
2466
2671
  @builtins.property
2467
2672
  def indexed_text_document_count(self) -> typing.Optional[jsii.Number]:
2468
- '''
2673
+ '''The number of text documents indexed.
2674
+
2469
2675
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-index-textdocumentstatistics.html#cfn-qbusiness-index-textdocumentstatistics-indexedtextdocumentcount
2470
2676
  '''
2471
2677
  result = self._values.get("indexed_text_document_count")
@@ -2510,13 +2716,13 @@ class CfnIndexProps:
2510
2716
  ) -> None:
2511
2717
  '''Properties for defining a ``CfnIndex``.
2512
2718
 
2513
- :param application_id:
2514
- :param display_name:
2515
- :param capacity_configuration:
2516
- :param description:
2517
- :param document_attribute_configurations:
2518
- :param tags:
2519
- :param type:
2719
+ :param application_id: The identifier of the Amazon Q Business application using the index.
2720
+ :param display_name: The name of the index.
2721
+ :param capacity_configuration: The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
2722
+ :param description: A description for the Amazon Q Business index.
2723
+ :param document_attribute_configurations: Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document. For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html>`_ .
2724
+ :param tags: A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
2725
+ :param type: The index type that's suitable for your needs. For more information on what's included in each type of index, see `Amazon Q Business tiers <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers>`_ .
2520
2726
 
2521
2727
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html
2522
2728
  :exampleMetadata: fixture=_generated
@@ -2574,7 +2780,8 @@ class CfnIndexProps:
2574
2780
 
2575
2781
  @builtins.property
2576
2782
  def application_id(self) -> builtins.str:
2577
- '''
2783
+ '''The identifier of the Amazon Q Business application using the index.
2784
+
2578
2785
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-applicationid
2579
2786
  '''
2580
2787
  result = self._values.get("application_id")
@@ -2583,7 +2790,8 @@ class CfnIndexProps:
2583
2790
 
2584
2791
  @builtins.property
2585
2792
  def display_name(self) -> builtins.str:
2586
- '''
2793
+ '''The name of the index.
2794
+
2587
2795
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-displayname
2588
2796
  '''
2589
2797
  result = self._values.get("display_name")
@@ -2594,7 +2802,10 @@ class CfnIndexProps:
2594
2802
  def capacity_configuration(
2595
2803
  self,
2596
2804
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnIndex.IndexCapacityConfigurationProperty]]:
2597
- '''
2805
+ '''The capacity units you want to provision for your index.
2806
+
2807
+ You can add and remove capacity to fit your usage needs.
2808
+
2598
2809
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration
2599
2810
  '''
2600
2811
  result = self._values.get("capacity_configuration")
@@ -2602,7 +2813,8 @@ class CfnIndexProps:
2602
2813
 
2603
2814
  @builtins.property
2604
2815
  def description(self) -> typing.Optional[builtins.str]:
2605
- '''
2816
+ '''A description for the Amazon Q Business index.
2817
+
2606
2818
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-description
2607
2819
  '''
2608
2820
  result = self._values.get("description")
@@ -2612,7 +2824,12 @@ class CfnIndexProps:
2612
2824
  def document_attribute_configurations(
2613
2825
  self,
2614
2826
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnIndex.DocumentAttributeConfigurationProperty]]]]:
2615
- '''
2827
+ '''Configuration information for document attributes.
2828
+
2829
+ Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
2830
+
2831
+ For more information, see `Understanding document attributes <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html>`_ .
2832
+
2616
2833
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations
2617
2834
  '''
2618
2835
  result = self._values.get("document_attribute_configurations")
@@ -2620,15 +2837,22 @@ class CfnIndexProps:
2620
2837
 
2621
2838
  @builtins.property
2622
2839
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
2623
- '''
2840
+ '''A list of key-value pairs that identify or categorize the index.
2841
+
2842
+ You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
2843
+
2624
2844
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags
2845
+ :: .
2625
2846
  '''
2626
2847
  result = self._values.get("tags")
2627
2848
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
2628
2849
 
2629
2850
  @builtins.property
2630
2851
  def type(self) -> typing.Optional[builtins.str]:
2631
- '''
2852
+ '''The index type that's suitable for your needs.
2853
+
2854
+ For more information on what's included in each type of index, see `Amazon Q Business tiers <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers>`_ .
2855
+
2632
2856
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type
2633
2857
  '''
2634
2858
  result = self._values.get("type")
@@ -2652,7 +2876,7 @@ class CfnPlugin(
2652
2876
  metaclass=jsii.JSIIMeta,
2653
2877
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnPlugin",
2654
2878
  ):
2655
- '''Definition of AWS::QBusiness::Plugin Resource Type.
2879
+ '''Information about an Amazon Q Business plugin and its configuration.
2656
2880
 
2657
2881
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html
2658
2882
  :cloudformationResource: AWS::QBusiness::Plugin
@@ -2720,14 +2944,14 @@ class CfnPlugin(
2720
2944
  '''
2721
2945
  :param scope: Scope in which this resource is defined.
2722
2946
  :param id: Construct identifier for this resource (unique in its scope).
2723
- :param application_id:
2724
- :param auth_configuration:
2725
- :param display_name:
2726
- :param type:
2727
- :param custom_plugin_configuration:
2728
- :param server_url:
2729
- :param state:
2730
- :param tags:
2947
+ :param application_id: The identifier of the application that will contain the plugin.
2948
+ :param auth_configuration: Authentication configuration information for an Amazon Q Business plugin.
2949
+ :param display_name: The name of the plugin.
2950
+ :param type: The type of the plugin.
2951
+ :param custom_plugin_configuration: Configuration information required to create a custom plugin.
2952
+ :param server_url: The plugin server URL used for configuration.
2953
+ :param state: The current status of the plugin.
2954
+ :param tags: A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
2731
2955
  '''
2732
2956
  if __debug__:
2733
2957
  type_hints = typing.get_type_hints(_typecheckingstub__65b6fb8d65ff428790a22d304932f2713710d70a9f6d789d819489f81a05b6f1)
@@ -2779,7 +3003,10 @@ class CfnPlugin(
2779
3003
  @builtins.property
2780
3004
  @jsii.member(jsii_name="attrBuildStatus")
2781
3005
  def attr_build_status(self) -> builtins.str:
2782
- '''
3006
+ '''The current status of a plugin.
3007
+
3008
+ A plugin is modified asynchronously.
3009
+
2783
3010
  :cloudformationAttribute: BuildStatus
2784
3011
  '''
2785
3012
  return typing.cast(builtins.str, jsii.get(self, "attrBuildStatus"))
@@ -2787,7 +3014,8 @@ class CfnPlugin(
2787
3014
  @builtins.property
2788
3015
  @jsii.member(jsii_name="attrCreatedAt")
2789
3016
  def attr_created_at(self) -> builtins.str:
2790
- '''
3017
+ '''The timestamp for when the plugin was created.
3018
+
2791
3019
  :cloudformationAttribute: CreatedAt
2792
3020
  '''
2793
3021
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -2795,7 +3023,8 @@ class CfnPlugin(
2795
3023
  @builtins.property
2796
3024
  @jsii.member(jsii_name="attrPluginArn")
2797
3025
  def attr_plugin_arn(self) -> builtins.str:
2798
- '''
3026
+ '''The Amazon Resource Name (ARN) of a plugin.
3027
+
2799
3028
  :cloudformationAttribute: PluginArn
2800
3029
  '''
2801
3030
  return typing.cast(builtins.str, jsii.get(self, "attrPluginArn"))
@@ -2803,7 +3032,8 @@ class CfnPlugin(
2803
3032
  @builtins.property
2804
3033
  @jsii.member(jsii_name="attrPluginId")
2805
3034
  def attr_plugin_id(self) -> builtins.str:
2806
- '''
3035
+ '''The identifier of the plugin.
3036
+
2807
3037
  :cloudformationAttribute: PluginId
2808
3038
  '''
2809
3039
  return typing.cast(builtins.str, jsii.get(self, "attrPluginId"))
@@ -2811,7 +3041,8 @@ class CfnPlugin(
2811
3041
  @builtins.property
2812
3042
  @jsii.member(jsii_name="attrUpdatedAt")
2813
3043
  def attr_updated_at(self) -> builtins.str:
2814
- '''
3044
+ '''The timestamp for when the plugin was last updated.
3045
+
2815
3046
  :cloudformationAttribute: UpdatedAt
2816
3047
  '''
2817
3048
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -2830,6 +3061,7 @@ class CfnPlugin(
2830
3061
  @builtins.property
2831
3062
  @jsii.member(jsii_name="applicationId")
2832
3063
  def application_id(self) -> builtins.str:
3064
+ '''The identifier of the application that will contain the plugin.'''
2833
3065
  return typing.cast(builtins.str, jsii.get(self, "applicationId"))
2834
3066
 
2835
3067
  @application_id.setter
@@ -2844,6 +3076,7 @@ class CfnPlugin(
2844
3076
  def auth_configuration(
2845
3077
  self,
2846
3078
  ) -> typing.Union[_IResolvable_da3f097b, "CfnPlugin.PluginAuthConfigurationProperty"]:
3079
+ '''Authentication configuration information for an Amazon Q Business plugin.'''
2847
3080
  return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnPlugin.PluginAuthConfigurationProperty"], jsii.get(self, "authConfiguration"))
2848
3081
 
2849
3082
  @auth_configuration.setter
@@ -2859,6 +3092,7 @@ class CfnPlugin(
2859
3092
  @builtins.property
2860
3093
  @jsii.member(jsii_name="displayName")
2861
3094
  def display_name(self) -> builtins.str:
3095
+ '''The name of the plugin.'''
2862
3096
  return typing.cast(builtins.str, jsii.get(self, "displayName"))
2863
3097
 
2864
3098
  @display_name.setter
@@ -2871,6 +3105,7 @@ class CfnPlugin(
2871
3105
  @builtins.property
2872
3106
  @jsii.member(jsii_name="type")
2873
3107
  def type(self) -> builtins.str:
3108
+ '''The type of the plugin.'''
2874
3109
  return typing.cast(builtins.str, jsii.get(self, "type"))
2875
3110
 
2876
3111
  @type.setter
@@ -2885,6 +3120,7 @@ class CfnPlugin(
2885
3120
  def custom_plugin_configuration(
2886
3121
  self,
2887
3122
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPlugin.CustomPluginConfigurationProperty"]]:
3123
+ '''Configuration information required to create a custom plugin.'''
2888
3124
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPlugin.CustomPluginConfigurationProperty"]], jsii.get(self, "customPluginConfiguration"))
2889
3125
 
2890
3126
  @custom_plugin_configuration.setter
@@ -2900,6 +3136,7 @@ class CfnPlugin(
2900
3136
  @builtins.property
2901
3137
  @jsii.member(jsii_name="serverUrl")
2902
3138
  def server_url(self) -> typing.Optional[builtins.str]:
3139
+ '''The plugin server URL used for configuration.'''
2903
3140
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "serverUrl"))
2904
3141
 
2905
3142
  @server_url.setter
@@ -2912,6 +3149,7 @@ class CfnPlugin(
2912
3149
  @builtins.property
2913
3150
  @jsii.member(jsii_name="state")
2914
3151
  def state(self) -> typing.Optional[builtins.str]:
3152
+ '''The current status of the plugin.'''
2915
3153
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "state"))
2916
3154
 
2917
3155
  @state.setter
@@ -2924,6 +3162,7 @@ class CfnPlugin(
2924
3162
  @builtins.property
2925
3163
  @jsii.member(jsii_name="tags")
2926
3164
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
3165
+ '''A list of key-value pairs that identify or categorize the data source connector.'''
2927
3166
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
2928
3167
 
2929
3168
  @tags.setter
@@ -2945,9 +3184,12 @@ class CfnPlugin(
2945
3184
  payload: typing.Optional[builtins.str] = None,
2946
3185
  s3: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPlugin.S3Property", typing.Dict[builtins.str, typing.Any]]]] = None,
2947
3186
  ) -> None:
2948
- '''
2949
- :param payload:
2950
- :param s3:
3187
+ '''Contains details about the OpenAPI schema for a custom plugin.
3188
+
3189
+ For more information, see `custom plugin OpenAPI schemas <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/custom-plugin.html#plugins-api-schema>`_ . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the ``s3`` field.
3190
+
3191
+ :param payload: The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
3192
+ :param s3: Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
2951
3193
 
2952
3194
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html
2953
3195
  :exampleMetadata: fixture=_generated
@@ -2978,7 +3220,8 @@ class CfnPlugin(
2978
3220
 
2979
3221
  @builtins.property
2980
3222
  def payload(self) -> typing.Optional[builtins.str]:
2981
- '''
3223
+ '''The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
3224
+
2982
3225
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-payload
2983
3226
  '''
2984
3227
  result = self._values.get("payload")
@@ -2988,7 +3231,10 @@ class CfnPlugin(
2988
3231
  def s3(
2989
3232
  self,
2990
3233
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPlugin.S3Property"]]:
2991
- '''
3234
+ '''Contains details about the S3 object containing the OpenAPI schema for a custom plugin.
3235
+
3236
+ The schema could be in either JSON or YAML format.
3237
+
2992
3238
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-apischema.html#cfn-qbusiness-plugin-apischema-s3
2993
3239
  '''
2994
3240
  result = self._values.get("s3")
@@ -3012,9 +3258,10 @@ class CfnPlugin(
3012
3258
  )
3013
3259
  class BasicAuthConfigurationProperty:
3014
3260
  def __init__(self, *, role_arn: builtins.str, secret_arn: builtins.str) -> None:
3015
- '''
3016
- :param role_arn:
3017
- :param secret_arn:
3261
+ '''Information about the basic authentication credentials used to configure a plugin.
3262
+
3263
+ :param role_arn: The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
3264
+ :param secret_arn: The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
3018
3265
 
3019
3266
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html
3020
3267
  :exampleMetadata: fixture=_generated
@@ -3041,7 +3288,8 @@ class CfnPlugin(
3041
3288
 
3042
3289
  @builtins.property
3043
3290
  def role_arn(self) -> builtins.str:
3044
- '''
3291
+ '''The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
3292
+
3045
3293
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-rolearn
3046
3294
  '''
3047
3295
  result = self._values.get("role_arn")
@@ -3050,7 +3298,8 @@ class CfnPlugin(
3050
3298
 
3051
3299
  @builtins.property
3052
3300
  def secret_arn(self) -> builtins.str:
3053
- '''
3301
+ '''The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
3302
+
3054
3303
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-secretarn
3055
3304
  '''
3056
3305
  result = self._values.get("secret_arn")
@@ -3085,10 +3334,11 @@ class CfnPlugin(
3085
3334
  api_schema_type: builtins.str,
3086
3335
  description: builtins.str,
3087
3336
  ) -> None:
3088
- '''
3089
- :param api_schema:
3090
- :param api_schema_type:
3091
- :param description:
3337
+ '''Configuration information required to create a custom plugin.
3338
+
3339
+ :param api_schema: Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
3340
+ :param api_schema_type: The type of OpenAPI schema to use.
3341
+ :param description: A description for your custom plugin configuration.
3092
3342
 
3093
3343
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html
3094
3344
  :exampleMetadata: fixture=_generated
@@ -3126,7 +3376,8 @@ class CfnPlugin(
3126
3376
  def api_schema(
3127
3377
  self,
3128
3378
  ) -> typing.Union[_IResolvable_da3f097b, "CfnPlugin.APISchemaProperty"]:
3129
- '''
3379
+ '''Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
3380
+
3130
3381
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischema
3131
3382
  '''
3132
3383
  result = self._values.get("api_schema")
@@ -3135,7 +3386,8 @@ class CfnPlugin(
3135
3386
 
3136
3387
  @builtins.property
3137
3388
  def api_schema_type(self) -> builtins.str:
3138
- '''
3389
+ '''The type of OpenAPI schema to use.
3390
+
3139
3391
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-apischematype
3140
3392
  '''
3141
3393
  result = self._values.get("api_schema_type")
@@ -3144,7 +3396,8 @@ class CfnPlugin(
3144
3396
 
3145
3397
  @builtins.property
3146
3398
  def description(self) -> builtins.str:
3147
- '''
3399
+ '''A description for your custom plugin configuration.
3400
+
3148
3401
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-custompluginconfiguration.html#cfn-qbusiness-plugin-custompluginconfiguration-description
3149
3402
  '''
3150
3403
  result = self._values.get("description")
@@ -3169,9 +3422,10 @@ class CfnPlugin(
3169
3422
  )
3170
3423
  class OAuth2ClientCredentialConfigurationProperty:
3171
3424
  def __init__(self, *, role_arn: builtins.str, secret_arn: builtins.str) -> None:
3172
- '''
3173
- :param role_arn:
3174
- :param secret_arn:
3425
+ '''Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
3426
+
3427
+ :param role_arn: The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
3428
+ :param secret_arn: The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
3175
3429
 
3176
3430
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html
3177
3431
  :exampleMetadata: fixture=_generated
@@ -3198,7 +3452,8 @@ class CfnPlugin(
3198
3452
 
3199
3453
  @builtins.property
3200
3454
  def role_arn(self) -> builtins.str:
3201
- '''
3455
+ '''The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
3456
+
3202
3457
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-rolearn
3203
3458
  '''
3204
3459
  result = self._values.get("role_arn")
@@ -3207,7 +3462,8 @@ class CfnPlugin(
3207
3462
 
3208
3463
  @builtins.property
3209
3464
  def secret_arn(self) -> builtins.str:
3210
- '''
3465
+ '''The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
3466
+
3211
3467
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-secretarn
3212
3468
  '''
3213
3469
  result = self._values.get("secret_arn")
@@ -3242,10 +3498,11 @@ class CfnPlugin(
3242
3498
  no_auth_configuration: typing.Any = None,
3243
3499
  o_auth2_client_credential_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPlugin.OAuth2ClientCredentialConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
3244
3500
  ) -> None:
3245
- '''
3246
- :param basic_auth_configuration:
3247
- :param no_auth_configuration:
3248
- :param o_auth2_client_credential_configuration:
3501
+ '''Authentication configuration information for an Amazon Q Business plugin.
3502
+
3503
+ :param basic_auth_configuration: Information about the basic authentication credentials used to configure a plugin.
3504
+ :param no_auth_configuration: Information about invoking a custom plugin without any authentication.
3505
+ :param o_auth2_client_credential_configuration: Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
3249
3506
 
3250
3507
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html
3251
3508
  :exampleMetadata: fixture=_generated
@@ -3287,7 +3544,8 @@ class CfnPlugin(
3287
3544
  def basic_auth_configuration(
3288
3545
  self,
3289
3546
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPlugin.BasicAuthConfigurationProperty"]]:
3290
- '''
3547
+ '''Information about the basic authentication credentials used to configure a plugin.
3548
+
3291
3549
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-basicauthconfiguration
3292
3550
  '''
3293
3551
  result = self._values.get("basic_auth_configuration")
@@ -3295,7 +3553,8 @@ class CfnPlugin(
3295
3553
 
3296
3554
  @builtins.property
3297
3555
  def no_auth_configuration(self) -> typing.Any:
3298
- '''
3556
+ '''Information about invoking a custom plugin without any authentication.
3557
+
3299
3558
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-noauthconfiguration
3300
3559
  '''
3301
3560
  result = self._values.get("no_auth_configuration")
@@ -3305,7 +3564,8 @@ class CfnPlugin(
3305
3564
  def o_auth2_client_credential_configuration(
3306
3565
  self,
3307
3566
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPlugin.OAuth2ClientCredentialConfigurationProperty"]]:
3308
- '''
3567
+ '''Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
3568
+
3309
3569
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-pluginauthconfiguration.html#cfn-qbusiness-plugin-pluginauthconfiguration-oauth2clientcredentialconfiguration
3310
3570
  '''
3311
3571
  result = self._values.get("o_auth2_client_credential_configuration")
@@ -3329,9 +3589,10 @@ class CfnPlugin(
3329
3589
  )
3330
3590
  class S3Property:
3331
3591
  def __init__(self, *, bucket: builtins.str, key: builtins.str) -> None:
3332
- '''
3333
- :param bucket:
3334
- :param key:
3592
+ '''Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
3593
+
3594
+ :param bucket: The name of the S3 bucket that contains the file.
3595
+ :param key: The name of the file.
3335
3596
 
3336
3597
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html
3337
3598
  :exampleMetadata: fixture=_generated
@@ -3358,7 +3619,8 @@ class CfnPlugin(
3358
3619
 
3359
3620
  @builtins.property
3360
3621
  def bucket(self) -> builtins.str:
3361
- '''
3622
+ '''The name of the S3 bucket that contains the file.
3623
+
3362
3624
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-bucket
3363
3625
  '''
3364
3626
  result = self._values.get("bucket")
@@ -3367,7 +3629,8 @@ class CfnPlugin(
3367
3629
 
3368
3630
  @builtins.property
3369
3631
  def key(self) -> builtins.str:
3370
- '''
3632
+ '''The name of the file.
3633
+
3371
3634
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-s3.html#cfn-qbusiness-plugin-s3-key
3372
3635
  '''
3373
3636
  result = self._values.get("key")
@@ -3415,14 +3678,14 @@ class CfnPluginProps:
3415
3678
  ) -> None:
3416
3679
  '''Properties for defining a ``CfnPlugin``.
3417
3680
 
3418
- :param application_id:
3419
- :param auth_configuration:
3420
- :param display_name:
3421
- :param type:
3422
- :param custom_plugin_configuration:
3423
- :param server_url:
3424
- :param state:
3425
- :param tags:
3681
+ :param application_id: The identifier of the application that will contain the plugin.
3682
+ :param auth_configuration: Authentication configuration information for an Amazon Q Business plugin.
3683
+ :param display_name: The name of the plugin.
3684
+ :param type: The type of the plugin.
3685
+ :param custom_plugin_configuration: Configuration information required to create a custom plugin.
3686
+ :param server_url: The plugin server URL used for configuration.
3687
+ :param state: The current status of the plugin.
3688
+ :param tags: A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
3426
3689
 
3427
3690
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html
3428
3691
  :exampleMetadata: fixture=_generated
@@ -3498,7 +3761,8 @@ class CfnPluginProps:
3498
3761
 
3499
3762
  @builtins.property
3500
3763
  def application_id(self) -> builtins.str:
3501
- '''
3764
+ '''The identifier of the application that will contain the plugin.
3765
+
3502
3766
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-applicationid
3503
3767
  '''
3504
3768
  result = self._values.get("application_id")
@@ -3509,7 +3773,8 @@ class CfnPluginProps:
3509
3773
  def auth_configuration(
3510
3774
  self,
3511
3775
  ) -> typing.Union[_IResolvable_da3f097b, CfnPlugin.PluginAuthConfigurationProperty]:
3512
- '''
3776
+ '''Authentication configuration information for an Amazon Q Business plugin.
3777
+
3513
3778
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-authconfiguration
3514
3779
  '''
3515
3780
  result = self._values.get("auth_configuration")
@@ -3518,7 +3783,8 @@ class CfnPluginProps:
3518
3783
 
3519
3784
  @builtins.property
3520
3785
  def display_name(self) -> builtins.str:
3521
- '''
3786
+ '''The name of the plugin.
3787
+
3522
3788
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-displayname
3523
3789
  '''
3524
3790
  result = self._values.get("display_name")
@@ -3527,7 +3793,8 @@ class CfnPluginProps:
3527
3793
 
3528
3794
  @builtins.property
3529
3795
  def type(self) -> builtins.str:
3530
- '''
3796
+ '''The type of the plugin.
3797
+
3531
3798
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-type
3532
3799
  '''
3533
3800
  result = self._values.get("type")
@@ -3538,7 +3805,8 @@ class CfnPluginProps:
3538
3805
  def custom_plugin_configuration(
3539
3806
  self,
3540
3807
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnPlugin.CustomPluginConfigurationProperty]]:
3541
- '''
3808
+ '''Configuration information required to create a custom plugin.
3809
+
3542
3810
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-custompluginconfiguration
3543
3811
  '''
3544
3812
  result = self._values.get("custom_plugin_configuration")
@@ -3546,7 +3814,8 @@ class CfnPluginProps:
3546
3814
 
3547
3815
  @builtins.property
3548
3816
  def server_url(self) -> typing.Optional[builtins.str]:
3549
- '''
3817
+ '''The plugin server URL used for configuration.
3818
+
3550
3819
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-serverurl
3551
3820
  '''
3552
3821
  result = self._values.get("server_url")
@@ -3554,7 +3823,8 @@ class CfnPluginProps:
3554
3823
 
3555
3824
  @builtins.property
3556
3825
  def state(self) -> typing.Optional[builtins.str]:
3557
- '''
3826
+ '''The current status of the plugin.
3827
+
3558
3828
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-state
3559
3829
  '''
3560
3830
  result = self._values.get("state")
@@ -3562,8 +3832,12 @@ class CfnPluginProps:
3562
3832
 
3563
3833
  @builtins.property
3564
3834
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
3565
- '''
3835
+ '''A list of key-value pairs that identify or categorize the data source connector.
3836
+
3837
+ You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
3838
+
3566
3839
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-plugin.html#cfn-qbusiness-plugin-tags
3840
+ :: .
3567
3841
  '''
3568
3842
  result = self._values.get("tags")
3569
3843
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
@@ -3586,7 +3860,7 @@ class CfnRetriever(
3586
3860
  metaclass=jsii.JSIIMeta,
3587
3861
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnRetriever",
3588
3862
  ):
3589
- '''Definition of AWS::QBusiness::Retriever Resource Type.
3863
+ '''Adds a retriever to your Amazon Q Business application.
3590
3864
 
3591
3865
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html
3592
3866
  :cloudformationResource: AWS::QBusiness::Retriever
@@ -3635,12 +3909,12 @@ class CfnRetriever(
3635
3909
  '''
3636
3910
  :param scope: Scope in which this resource is defined.
3637
3911
  :param id: Construct identifier for this resource (unique in its scope).
3638
- :param application_id:
3639
- :param configuration:
3640
- :param display_name:
3641
- :param type:
3642
- :param role_arn:
3643
- :param tags:
3912
+ :param application_id: The identifier of the Amazon Q Business application using the retriever.
3913
+ :param configuration: Provides information on how the retriever used for your Amazon Q Business application is configured.
3914
+ :param display_name: The name of your retriever.
3915
+ :param type: The type of your retriever.
3916
+ :param role_arn: The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
3917
+ :param tags: A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
3644
3918
  '''
3645
3919
  if __debug__:
3646
3920
  type_hints = typing.get_type_hints(_typecheckingstub__793749362ec6ccd890aa9273b100a2ba004492449f0dba0ea4eb4909560d6761)
@@ -3690,7 +3964,8 @@ class CfnRetriever(
3690
3964
  @builtins.property
3691
3965
  @jsii.member(jsii_name="attrCreatedAt")
3692
3966
  def attr_created_at(self) -> builtins.str:
3693
- '''
3967
+ '''The Unix timestamp when the retriever was created.
3968
+
3694
3969
  :cloudformationAttribute: CreatedAt
3695
3970
  '''
3696
3971
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -3698,7 +3973,8 @@ class CfnRetriever(
3698
3973
  @builtins.property
3699
3974
  @jsii.member(jsii_name="attrRetrieverArn")
3700
3975
  def attr_retriever_arn(self) -> builtins.str:
3701
- '''
3976
+ '''The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
3977
+
3702
3978
  :cloudformationAttribute: RetrieverArn
3703
3979
  '''
3704
3980
  return typing.cast(builtins.str, jsii.get(self, "attrRetrieverArn"))
@@ -3706,7 +3982,8 @@ class CfnRetriever(
3706
3982
  @builtins.property
3707
3983
  @jsii.member(jsii_name="attrRetrieverId")
3708
3984
  def attr_retriever_id(self) -> builtins.str:
3709
- '''
3985
+ '''The identifier of the retriever used by your Amazon Q Business application.
3986
+
3710
3987
  :cloudformationAttribute: RetrieverId
3711
3988
  '''
3712
3989
  return typing.cast(builtins.str, jsii.get(self, "attrRetrieverId"))
@@ -3714,7 +3991,8 @@ class CfnRetriever(
3714
3991
  @builtins.property
3715
3992
  @jsii.member(jsii_name="attrStatus")
3716
3993
  def attr_status(self) -> builtins.str:
3717
- '''
3994
+ '''The status of your retriever.
3995
+
3718
3996
  :cloudformationAttribute: Status
3719
3997
  '''
3720
3998
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -3722,7 +4000,8 @@ class CfnRetriever(
3722
4000
  @builtins.property
3723
4001
  @jsii.member(jsii_name="attrUpdatedAt")
3724
4002
  def attr_updated_at(self) -> builtins.str:
3725
- '''
4003
+ '''The Unix timestamp when the retriever was last updated.
4004
+
3726
4005
  :cloudformationAttribute: UpdatedAt
3727
4006
  '''
3728
4007
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -3741,6 +4020,7 @@ class CfnRetriever(
3741
4020
  @builtins.property
3742
4021
  @jsii.member(jsii_name="applicationId")
3743
4022
  def application_id(self) -> builtins.str:
4023
+ '''The identifier of the Amazon Q Business application using the retriever.'''
3744
4024
  return typing.cast(builtins.str, jsii.get(self, "applicationId"))
3745
4025
 
3746
4026
  @application_id.setter
@@ -3755,6 +4035,7 @@ class CfnRetriever(
3755
4035
  def configuration(
3756
4036
  self,
3757
4037
  ) -> typing.Union[_IResolvable_da3f097b, "CfnRetriever.RetrieverConfigurationProperty"]:
4038
+ '''Provides information on how the retriever used for your Amazon Q Business application is configured.'''
3758
4039
  return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnRetriever.RetrieverConfigurationProperty"], jsii.get(self, "configuration"))
3759
4040
 
3760
4041
  @configuration.setter
@@ -3770,6 +4051,7 @@ class CfnRetriever(
3770
4051
  @builtins.property
3771
4052
  @jsii.member(jsii_name="displayName")
3772
4053
  def display_name(self) -> builtins.str:
4054
+ '''The name of your retriever.'''
3773
4055
  return typing.cast(builtins.str, jsii.get(self, "displayName"))
3774
4056
 
3775
4057
  @display_name.setter
@@ -3782,6 +4064,7 @@ class CfnRetriever(
3782
4064
  @builtins.property
3783
4065
  @jsii.member(jsii_name="type")
3784
4066
  def type(self) -> builtins.str:
4067
+ '''The type of your retriever.'''
3785
4068
  return typing.cast(builtins.str, jsii.get(self, "type"))
3786
4069
 
3787
4070
  @type.setter
@@ -3794,6 +4077,7 @@ class CfnRetriever(
3794
4077
  @builtins.property
3795
4078
  @jsii.member(jsii_name="roleArn")
3796
4079
  def role_arn(self) -> typing.Optional[builtins.str]:
4080
+ '''The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.'''
3797
4081
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "roleArn"))
3798
4082
 
3799
4083
  @role_arn.setter
@@ -3806,6 +4090,7 @@ class CfnRetriever(
3806
4090
  @builtins.property
3807
4091
  @jsii.member(jsii_name="tags")
3808
4092
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
4093
+ '''A list of key-value pairs that identify or categorize the retriever.'''
3809
4094
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
3810
4095
 
3811
4096
  @tags.setter
@@ -3822,8 +4107,9 @@ class CfnRetriever(
3822
4107
  )
3823
4108
  class KendraIndexConfigurationProperty:
3824
4109
  def __init__(self, *, index_id: builtins.str) -> None:
3825
- '''
3826
- :param index_id:
4110
+ '''Stores an Amazon Kendra index as a retriever.
4111
+
4112
+ :param index_id: The identifier of the Amazon Kendra index.
3827
4113
 
3828
4114
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-kendraindexconfiguration.html
3829
4115
  :exampleMetadata: fixture=_generated
@@ -3847,7 +4133,8 @@ class CfnRetriever(
3847
4133
 
3848
4134
  @builtins.property
3849
4135
  def index_id(self) -> builtins.str:
3850
- '''
4136
+ '''The identifier of the Amazon Kendra index.
4137
+
3851
4138
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-kendraindexconfiguration.html#cfn-qbusiness-retriever-kendraindexconfiguration-indexid
3852
4139
  '''
3853
4140
  result = self._values.get("index_id")
@@ -3872,8 +4159,9 @@ class CfnRetriever(
3872
4159
  )
3873
4160
  class NativeIndexConfigurationProperty:
3874
4161
  def __init__(self, *, index_id: builtins.str) -> None:
3875
- '''
3876
- :param index_id:
4162
+ '''Configuration information for an Amazon Q Business index.
4163
+
4164
+ :param index_id: The identifier for the Amazon Q Business index.
3877
4165
 
3878
4166
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-nativeindexconfiguration.html
3879
4167
  :exampleMetadata: fixture=_generated
@@ -3897,7 +4185,8 @@ class CfnRetriever(
3897
4185
 
3898
4186
  @builtins.property
3899
4187
  def index_id(self) -> builtins.str:
3900
- '''
4188
+ '''The identifier for the Amazon Q Business index.
4189
+
3901
4190
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-nativeindexconfiguration.html#cfn-qbusiness-retriever-nativeindexconfiguration-indexid
3902
4191
  '''
3903
4192
  result = self._values.get("index_id")
@@ -3930,9 +4219,10 @@ class CfnRetriever(
3930
4219
  kendra_index_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnRetriever.KendraIndexConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
3931
4220
  native_index_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnRetriever.NativeIndexConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
3932
4221
  ) -> None:
3933
- '''
3934
- :param kendra_index_configuration:
3935
- :param native_index_configuration:
4222
+ '''Provides information on how the retriever used for your Amazon Q Business application is configured.
4223
+
4224
+ :param kendra_index_configuration: Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
4225
+ :param native_index_configuration: Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
3936
4226
 
3937
4227
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html
3938
4228
  :exampleMetadata: fixture=_generated
@@ -3966,7 +4256,8 @@ class CfnRetriever(
3966
4256
  def kendra_index_configuration(
3967
4257
  self,
3968
4258
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRetriever.KendraIndexConfigurationProperty"]]:
3969
- '''
4259
+ '''Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
4260
+
3970
4261
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-kendraindexconfiguration
3971
4262
  '''
3972
4263
  result = self._values.get("kendra_index_configuration")
@@ -3976,7 +4267,8 @@ class CfnRetriever(
3976
4267
  def native_index_configuration(
3977
4268
  self,
3978
4269
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnRetriever.NativeIndexConfigurationProperty"]]:
3979
- '''
4270
+ '''Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
4271
+
3980
4272
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-nativeindexconfiguration
3981
4273
  '''
3982
4274
  result = self._values.get("native_index_configuration")
@@ -4019,12 +4311,12 @@ class CfnRetrieverProps:
4019
4311
  ) -> None:
4020
4312
  '''Properties for defining a ``CfnRetriever``.
4021
4313
 
4022
- :param application_id:
4023
- :param configuration:
4024
- :param display_name:
4025
- :param type:
4026
- :param role_arn:
4027
- :param tags:
4314
+ :param application_id: The identifier of the Amazon Q Business application using the retriever.
4315
+ :param configuration: Provides information on how the retriever used for your Amazon Q Business application is configured.
4316
+ :param display_name: The name of your retriever.
4317
+ :param type: The type of your retriever.
4318
+ :param role_arn: The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
4319
+ :param tags: A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
4028
4320
 
4029
4321
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html
4030
4322
  :exampleMetadata: fixture=_generated
@@ -4077,7 +4369,8 @@ class CfnRetrieverProps:
4077
4369
 
4078
4370
  @builtins.property
4079
4371
  def application_id(self) -> builtins.str:
4080
- '''
4372
+ '''The identifier of the Amazon Q Business application using the retriever.
4373
+
4081
4374
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-applicationid
4082
4375
  '''
4083
4376
  result = self._values.get("application_id")
@@ -4088,7 +4381,8 @@ class CfnRetrieverProps:
4088
4381
  def configuration(
4089
4382
  self,
4090
4383
  ) -> typing.Union[_IResolvable_da3f097b, CfnRetriever.RetrieverConfigurationProperty]:
4091
- '''
4384
+ '''Provides information on how the retriever used for your Amazon Q Business application is configured.
4385
+
4092
4386
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-configuration
4093
4387
  '''
4094
4388
  result = self._values.get("configuration")
@@ -4097,7 +4391,8 @@ class CfnRetrieverProps:
4097
4391
 
4098
4392
  @builtins.property
4099
4393
  def display_name(self) -> builtins.str:
4100
- '''
4394
+ '''The name of your retriever.
4395
+
4101
4396
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-displayname
4102
4397
  '''
4103
4398
  result = self._values.get("display_name")
@@ -4106,7 +4401,8 @@ class CfnRetrieverProps:
4106
4401
 
4107
4402
  @builtins.property
4108
4403
  def type(self) -> builtins.str:
4109
- '''
4404
+ '''The type of your retriever.
4405
+
4110
4406
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-type
4111
4407
  '''
4112
4408
  result = self._values.get("type")
@@ -4115,7 +4411,8 @@ class CfnRetrieverProps:
4115
4411
 
4116
4412
  @builtins.property
4117
4413
  def role_arn(self) -> typing.Optional[builtins.str]:
4118
- '''
4414
+ '''The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
4415
+
4119
4416
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-rolearn
4120
4417
  '''
4121
4418
  result = self._values.get("role_arn")
@@ -4123,8 +4420,12 @@ class CfnRetrieverProps:
4123
4420
 
4124
4421
  @builtins.property
4125
4422
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
4126
- '''
4423
+ '''A list of key-value pairs that identify or categorize the retriever.
4424
+
4425
+ You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
4426
+
4127
4427
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-tags
4428
+ :: .
4128
4429
  '''
4129
4430
  result = self._values.get("tags")
4130
4431
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
@@ -4147,7 +4448,7 @@ class CfnWebExperience(
4147
4448
  metaclass=jsii.JSIIMeta,
4148
4449
  jsii_type="aws-cdk-lib.aws_qbusiness.CfnWebExperience",
4149
4450
  ):
4150
- '''Definition of AWS::QBusiness::WebExperience Resource Type.
4451
+ '''Creates an Amazon Q Business web experience.
4151
4452
 
4152
4453
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html
4153
4454
  :cloudformationResource: AWS::QBusiness::WebExperience
@@ -4191,13 +4492,13 @@ class CfnWebExperience(
4191
4492
  '''
4192
4493
  :param scope: Scope in which this resource is defined.
4193
4494
  :param id: Construct identifier for this resource (unique in its scope).
4194
- :param application_id:
4195
- :param role_arn:
4196
- :param sample_prompts_control_mode:
4197
- :param subtitle:
4198
- :param tags:
4199
- :param title:
4200
- :param welcome_message:
4495
+ :param application_id: The identifier of the Amazon Q Business web experience.
4496
+ :param role_arn: The Amazon Resource Name (ARN) of the service role attached to your web experience.
4497
+ :param sample_prompts_control_mode: Determines whether sample prompts are enabled in the web experience for an end user.
4498
+ :param subtitle: A subtitle to personalize your Amazon Q Business web experience.
4499
+ :param tags: A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
4500
+ :param title: The title for your Amazon Q Business web experience.
4501
+ :param welcome_message: A message in an Amazon Q Business web experience.
4201
4502
  '''
4202
4503
  if __debug__:
4203
4504
  type_hints = typing.get_type_hints(_typecheckingstub__357871375e43a0ed6fbb398668ece13df26dff3afca5c98268a56fffdb09ec8d)
@@ -4248,7 +4549,8 @@ class CfnWebExperience(
4248
4549
  @builtins.property
4249
4550
  @jsii.member(jsii_name="attrCreatedAt")
4250
4551
  def attr_created_at(self) -> builtins.str:
4251
- '''
4552
+ '''The Unix timestamp when the Amazon Q Business application was last updated.
4553
+
4252
4554
  :cloudformationAttribute: CreatedAt
4253
4555
  '''
4254
4556
  return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
@@ -4256,7 +4558,10 @@ class CfnWebExperience(
4256
4558
  @builtins.property
4257
4559
  @jsii.member(jsii_name="attrDefaultEndpoint")
4258
4560
  def attr_default_endpoint(self) -> builtins.str:
4259
- '''
4561
+ '''The endpoint URLs for your Amazon Q Business web experience.
4562
+
4563
+ The URLs are unique and fully hosted by AWS .
4564
+
4260
4565
  :cloudformationAttribute: DefaultEndpoint
4261
4566
  '''
4262
4567
  return typing.cast(builtins.str, jsii.get(self, "attrDefaultEndpoint"))
@@ -4264,7 +4569,8 @@ class CfnWebExperience(
4264
4569
  @builtins.property
4265
4570
  @jsii.member(jsii_name="attrStatus")
4266
4571
  def attr_status(self) -> builtins.str:
4267
- '''
4572
+ '''The status of your Amazon Q Business web experience.
4573
+
4268
4574
  :cloudformationAttribute: Status
4269
4575
  '''
4270
4576
  return typing.cast(builtins.str, jsii.get(self, "attrStatus"))
@@ -4272,7 +4578,8 @@ class CfnWebExperience(
4272
4578
  @builtins.property
4273
4579
  @jsii.member(jsii_name="attrUpdatedAt")
4274
4580
  def attr_updated_at(self) -> builtins.str:
4275
- '''
4581
+ '''The Unix timestamp when your Amazon Q Business web experience was updated.
4582
+
4276
4583
  :cloudformationAttribute: UpdatedAt
4277
4584
  '''
4278
4585
  return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
@@ -4280,7 +4587,8 @@ class CfnWebExperience(
4280
4587
  @builtins.property
4281
4588
  @jsii.member(jsii_name="attrWebExperienceArn")
4282
4589
  def attr_web_experience_arn(self) -> builtins.str:
4283
- '''
4590
+ '''The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
4591
+
4284
4592
  :cloudformationAttribute: WebExperienceArn
4285
4593
  '''
4286
4594
  return typing.cast(builtins.str, jsii.get(self, "attrWebExperienceArn"))
@@ -4288,7 +4596,8 @@ class CfnWebExperience(
4288
4596
  @builtins.property
4289
4597
  @jsii.member(jsii_name="attrWebExperienceId")
4290
4598
  def attr_web_experience_id(self) -> builtins.str:
4291
- '''
4599
+ '''The identifier of your Amazon Q Business web experience.
4600
+
4292
4601
  :cloudformationAttribute: WebExperienceId
4293
4602
  '''
4294
4603
  return typing.cast(builtins.str, jsii.get(self, "attrWebExperienceId"))
@@ -4307,6 +4616,7 @@ class CfnWebExperience(
4307
4616
  @builtins.property
4308
4617
  @jsii.member(jsii_name="applicationId")
4309
4618
  def application_id(self) -> builtins.str:
4619
+ '''The identifier of the Amazon Q Business web experience.'''
4310
4620
  return typing.cast(builtins.str, jsii.get(self, "applicationId"))
4311
4621
 
4312
4622
  @application_id.setter
@@ -4319,6 +4629,7 @@ class CfnWebExperience(
4319
4629
  @builtins.property
4320
4630
  @jsii.member(jsii_name="roleArn")
4321
4631
  def role_arn(self) -> typing.Optional[builtins.str]:
4632
+ '''The Amazon Resource Name (ARN) of the service role attached to your web experience.'''
4322
4633
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "roleArn"))
4323
4634
 
4324
4635
  @role_arn.setter
@@ -4331,6 +4642,7 @@ class CfnWebExperience(
4331
4642
  @builtins.property
4332
4643
  @jsii.member(jsii_name="samplePromptsControlMode")
4333
4644
  def sample_prompts_control_mode(self) -> typing.Optional[builtins.str]:
4645
+ '''Determines whether sample prompts are enabled in the web experience for an end user.'''
4334
4646
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "samplePromptsControlMode"))
4335
4647
 
4336
4648
  @sample_prompts_control_mode.setter
@@ -4343,6 +4655,7 @@ class CfnWebExperience(
4343
4655
  @builtins.property
4344
4656
  @jsii.member(jsii_name="subtitle")
4345
4657
  def subtitle(self) -> typing.Optional[builtins.str]:
4658
+ '''A subtitle to personalize your Amazon Q Business web experience.'''
4346
4659
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "subtitle"))
4347
4660
 
4348
4661
  @subtitle.setter
@@ -4355,6 +4668,7 @@ class CfnWebExperience(
4355
4668
  @builtins.property
4356
4669
  @jsii.member(jsii_name="tags")
4357
4670
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
4671
+ '''A list of key-value pairs that identify or categorize your Amazon Q Business web experience.'''
4358
4672
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
4359
4673
 
4360
4674
  @tags.setter
@@ -4367,6 +4681,7 @@ class CfnWebExperience(
4367
4681
  @builtins.property
4368
4682
  @jsii.member(jsii_name="title")
4369
4683
  def title(self) -> typing.Optional[builtins.str]:
4684
+ '''The title for your Amazon Q Business web experience.'''
4370
4685
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "title"))
4371
4686
 
4372
4687
  @title.setter
@@ -4379,6 +4694,7 @@ class CfnWebExperience(
4379
4694
  @builtins.property
4380
4695
  @jsii.member(jsii_name="welcomeMessage")
4381
4696
  def welcome_message(self) -> typing.Optional[builtins.str]:
4697
+ '''A message in an Amazon Q Business web experience.'''
4382
4698
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "welcomeMessage"))
4383
4699
 
4384
4700
  @welcome_message.setter
@@ -4416,13 +4732,13 @@ class CfnWebExperienceProps:
4416
4732
  ) -> None:
4417
4733
  '''Properties for defining a ``CfnWebExperience``.
4418
4734
 
4419
- :param application_id:
4420
- :param role_arn:
4421
- :param sample_prompts_control_mode:
4422
- :param subtitle:
4423
- :param tags:
4424
- :param title:
4425
- :param welcome_message:
4735
+ :param application_id: The identifier of the Amazon Q Business web experience.
4736
+ :param role_arn: The Amazon Resource Name (ARN) of the service role attached to your web experience.
4737
+ :param sample_prompts_control_mode: Determines whether sample prompts are enabled in the web experience for an end user.
4738
+ :param subtitle: A subtitle to personalize your Amazon Q Business web experience.
4739
+ :param tags: A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
4740
+ :param title: The title for your Amazon Q Business web experience.
4741
+ :param welcome_message: A message in an Amazon Q Business web experience.
4426
4742
 
4427
4743
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html
4428
4744
  :exampleMetadata: fixture=_generated
@@ -4475,7 +4791,8 @@ class CfnWebExperienceProps:
4475
4791
 
4476
4792
  @builtins.property
4477
4793
  def application_id(self) -> builtins.str:
4478
- '''
4794
+ '''The identifier of the Amazon Q Business web experience.
4795
+
4479
4796
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-applicationid
4480
4797
  '''
4481
4798
  result = self._values.get("application_id")
@@ -4484,7 +4801,8 @@ class CfnWebExperienceProps:
4484
4801
 
4485
4802
  @builtins.property
4486
4803
  def role_arn(self) -> typing.Optional[builtins.str]:
4487
- '''
4804
+ '''The Amazon Resource Name (ARN) of the service role attached to your web experience.
4805
+
4488
4806
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-rolearn
4489
4807
  '''
4490
4808
  result = self._values.get("role_arn")
@@ -4492,7 +4810,8 @@ class CfnWebExperienceProps:
4492
4810
 
4493
4811
  @builtins.property
4494
4812
  def sample_prompts_control_mode(self) -> typing.Optional[builtins.str]:
4495
- '''
4813
+ '''Determines whether sample prompts are enabled in the web experience for an end user.
4814
+
4496
4815
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-samplepromptscontrolmode
4497
4816
  '''
4498
4817
  result = self._values.get("sample_prompts_control_mode")
@@ -4500,7 +4819,8 @@ class CfnWebExperienceProps:
4500
4819
 
4501
4820
  @builtins.property
4502
4821
  def subtitle(self) -> typing.Optional[builtins.str]:
4503
- '''
4822
+ '''A subtitle to personalize your Amazon Q Business web experience.
4823
+
4504
4824
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-subtitle
4505
4825
  '''
4506
4826
  result = self._values.get("subtitle")
@@ -4508,15 +4828,20 @@ class CfnWebExperienceProps:
4508
4828
 
4509
4829
  @builtins.property
4510
4830
  def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
4511
- '''
4831
+ '''A list of key-value pairs that identify or categorize your Amazon Q Business web experience.
4832
+
4833
+ You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
4834
+
4512
4835
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-tags
4836
+ :: .
4513
4837
  '''
4514
4838
  result = self._values.get("tags")
4515
4839
  return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
4516
4840
 
4517
4841
  @builtins.property
4518
4842
  def title(self) -> typing.Optional[builtins.str]:
4519
- '''
4843
+ '''The title for your Amazon Q Business web experience.
4844
+
4520
4845
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-title
4521
4846
  '''
4522
4847
  result = self._values.get("title")
@@ -4524,7 +4849,8 @@ class CfnWebExperienceProps:
4524
4849
 
4525
4850
  @builtins.property
4526
4851
  def welcome_message(self) -> typing.Optional[builtins.str]:
4527
- '''
4852
+ '''A message in an Amazon Q Business web experience.
4853
+
4528
4854
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-welcomemessage
4529
4855
  '''
4530
4856
  result = self._values.get("welcome_message")