aws-cdk-lib 2.173.4__py3-none-any.whl → 2.174.1__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.
- aws_cdk/__init__.py +210 -181
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.173.4.jsii.tgz → aws-cdk-lib@2.174.1.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +18 -0
- aws_cdk/aws_apigateway/__init__.py +127 -168
- aws_cdk/aws_appconfig/__init__.py +498 -1
- aws_cdk/aws_applicationautoscaling/__init__.py +4 -1
- aws_cdk/aws_appsync/__init__.py +4 -0
- aws_cdk/aws_autoscaling/__init__.py +96 -0
- aws_cdk/aws_batch/__init__.py +662 -237
- aws_cdk/aws_bedrock/__init__.py +2122 -181
- aws_cdk/aws_cassandra/__init__.py +476 -4
- aws_cdk/aws_cleanrooms/__init__.py +1227 -20
- aws_cdk/aws_cloudformation/__init__.py +172 -169
- aws_cdk/aws_cloudfront/__init__.py +773 -26
- aws_cdk/aws_cloudtrail/__init__.py +8 -2
- aws_cdk/aws_codebuild/__init__.py +83 -0
- aws_cdk/aws_codepipeline/__init__.py +2 -1
- aws_cdk/aws_cognito/__init__.py +232 -200
- aws_cdk/aws_connect/__init__.py +187 -36
- aws_cdk/aws_connectcampaignsv2/__init__.py +106 -12
- aws_cdk/aws_databrew/__init__.py +69 -1
- aws_cdk/aws_datasync/__init__.py +33 -28
- aws_cdk/aws_datazone/__init__.py +141 -41
- aws_cdk/aws_dlm/__init__.py +20 -10
- aws_cdk/aws_dms/__init__.py +736 -22
- aws_cdk/aws_docdb/__init__.py +134 -0
- aws_cdk/aws_dynamodb/__init__.py +76 -4
- aws_cdk/aws_ec2/__init__.py +1233 -65
- aws_cdk/aws_ecr/__init__.py +31 -0
- aws_cdk/aws_ecr_assets/__init__.py +5 -0
- aws_cdk/aws_ecs/__init__.py +88 -11
- aws_cdk/aws_efs/__init__.py +15 -8
- aws_cdk/aws_eks/__init__.py +114 -45
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +2 -2
- aws_cdk/aws_emrserverless/__init__.py +143 -0
- aws_cdk/aws_events/__init__.py +50 -30
- aws_cdk/aws_fis/__init__.py +33 -33
- aws_cdk/aws_fsx/__init__.py +20 -10
- aws_cdk/aws_glue/__init__.py +34 -11
- aws_cdk/aws_greengrass/__init__.py +8 -8
- aws_cdk/aws_guardduty/__init__.py +1 -1
- aws_cdk/aws_imagebuilder/__init__.py +45 -47
- aws_cdk/aws_internetmonitor/__init__.py +3 -3
- aws_cdk/aws_invoicing/__init__.py +55 -30
- aws_cdk/aws_iot/__init__.py +1117 -4
- aws_cdk/aws_iot1click/__init__.py +17 -7
- aws_cdk/aws_kendra/__init__.py +4 -6
- aws_cdk/aws_lambda/__init__.py +15 -1
- aws_cdk/aws_logs/__init__.py +4011 -86
- aws_cdk/aws_m2/__init__.py +41 -0
- aws_cdk/aws_mediaconnect/__init__.py +202 -7
- aws_cdk/aws_mediaconvert/__init__.py +39 -0
- aws_cdk/aws_memorydb/__init__.py +22 -22
- aws_cdk/aws_networkmanager/__init__.py +758 -0
- aws_cdk/aws_opensearchservice/__init__.py +222 -0
- aws_cdk/aws_organizations/__init__.py +5 -3
- aws_cdk/aws_pcs/__init__.py +3038 -0
- aws_cdk/aws_pipes/__init__.py +10 -10
- aws_cdk/aws_qbusiness/__init__.py +415 -140
- aws_cdk/aws_quicksight/__init__.py +59795 -49748
- aws_cdk/aws_ram/__init__.py +5 -11
- aws_cdk/aws_rbin/__init__.py +28 -16
- aws_cdk/aws_rds/__init__.py +186 -31
- aws_cdk/aws_redshiftserverless/__init__.py +156 -0
- aws_cdk/aws_resiliencehub/__init__.py +2 -1
- aws_cdk/aws_route53_targets/__init__.py +5 -5
- aws_cdk/aws_s3/__init__.py +25 -15
- aws_cdk/aws_s3express/__init__.py +7 -7
- aws_cdk/aws_s3tables/__init__.py +683 -0
- aws_cdk/aws_sagemaker/__init__.py +580 -195
- aws_cdk/aws_secretsmanager/__init__.py +2 -0
- aws_cdk/aws_securityhub/__init__.py +41 -165
- aws_cdk/aws_servicediscovery/__init__.py +10 -3
- aws_cdk/aws_ses/__init__.py +190 -5
- aws_cdk/aws_sns/__init__.py +7 -3
- aws_cdk/aws_synthetics/__init__.py +29 -4
- aws_cdk/aws_transfer/__init__.py +8 -0
- aws_cdk/aws_vpclattice/__init__.py +147 -77
- aws_cdk/aws_wafv2/__init__.py +20 -8
- aws_cdk/aws_wisdom/__init__.py +162 -111
- aws_cdk/aws_workspaces/__init__.py +10 -4
- aws_cdk/cloud_assembly_schema/__init__.py +22 -0
- aws_cdk/custom_resources/__init__.py +31 -0
- aws_cdk/cx_api/__init__.py +19 -0
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/LICENSE +1 -1
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/NOTICE +1 -1
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/RECORD +91 -89
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.173.4.dist-info → aws_cdk_lib-2.174.1.dist-info}/top_level.txt +0 -0
|
@@ -169,7 +169,7 @@ class CfnApplication(
|
|
|
169
169
|
:param display_name: The name of the Amazon Q Business application.
|
|
170
170
|
:param attachments_configuration: Configuration information for the file upload during chat feature.
|
|
171
171
|
:param auto_subscription_configuration: Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
|
|
172
|
-
:param client_ids_for_oidc:
|
|
172
|
+
:param client_ids_for_oidc: The OIDC client ID for a Amazon Q Business application.
|
|
173
173
|
:param description: A description for the Amazon Q Business application.
|
|
174
174
|
: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.
|
|
175
175
|
:param iam_identity_provider_arn: The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
|
|
@@ -177,7 +177,7 @@ class CfnApplication(
|
|
|
177
177
|
:param identity_type: The authentication type being used by a Amazon Q Business application.
|
|
178
178
|
:param personalization_configuration: Configuration information about chat response personalization. For more information, see `Personalizing chat responses <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html>`_ .
|
|
179
179
|
:param q_apps_configuration: Configuration information about Amazon Q Apps.
|
|
180
|
-
:param quick_sight_configuration:
|
|
180
|
+
:param quick_sight_configuration: The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
|
|
181
181
|
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a `service linked role (SLR) <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions>`_ and use it as the application's role.
|
|
182
182
|
: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: _ . : / = + -
|
|
183
183
|
'''
|
|
@@ -353,6 +353,7 @@ class CfnApplication(
|
|
|
353
353
|
@builtins.property
|
|
354
354
|
@jsii.member(jsii_name="clientIdsForOidc")
|
|
355
355
|
def client_ids_for_oidc(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
356
|
+
'''The OIDC client ID for a Amazon Q Business application.'''
|
|
356
357
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "clientIdsForOidc"))
|
|
357
358
|
|
|
358
359
|
@client_ids_for_oidc.setter
|
|
@@ -479,6 +480,7 @@ class CfnApplication(
|
|
|
479
480
|
def quick_sight_configuration(
|
|
480
481
|
self,
|
|
481
482
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.QuickSightConfigurationProperty"]]:
|
|
483
|
+
'''The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.'''
|
|
482
484
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnApplication.QuickSightConfigurationProperty"]], jsii.get(self, "quickSightConfiguration"))
|
|
483
485
|
|
|
484
486
|
@quick_sight_configuration.setter
|
|
@@ -815,8 +817,11 @@ class CfnApplication(
|
|
|
815
817
|
)
|
|
816
818
|
class QuickSightConfigurationProperty:
|
|
817
819
|
def __init__(self, *, client_namespace: builtins.str) -> None:
|
|
818
|
-
'''
|
|
819
|
-
|
|
820
|
+
'''The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
|
|
821
|
+
|
|
822
|
+
For more information, see `Creating an Amazon QuickSight integrated application <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html>`_ .
|
|
823
|
+
|
|
824
|
+
:param client_namespace: The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see `Namespace operations <https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html>`_ .
|
|
820
825
|
|
|
821
826
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.html
|
|
822
827
|
:exampleMetadata: fixture=_generated
|
|
@@ -840,7 +845,10 @@ class CfnApplication(
|
|
|
840
845
|
|
|
841
846
|
@builtins.property
|
|
842
847
|
def client_namespace(self) -> builtins.str:
|
|
843
|
-
'''
|
|
848
|
+
'''The Amazon QuickSight namespace that is used as the identity provider.
|
|
849
|
+
|
|
850
|
+
For more information about QuickSight namespaces, see `Namespace operations <https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html>`_ .
|
|
851
|
+
|
|
844
852
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.html#cfn-qbusiness-application-quicksightconfiguration-clientnamespace
|
|
845
853
|
'''
|
|
846
854
|
result = self._values.get("client_namespace")
|
|
@@ -903,7 +911,7 @@ class CfnApplicationProps:
|
|
|
903
911
|
:param display_name: The name of the Amazon Q Business application.
|
|
904
912
|
:param attachments_configuration: Configuration information for the file upload during chat feature.
|
|
905
913
|
:param auto_subscription_configuration: Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
|
|
906
|
-
:param client_ids_for_oidc:
|
|
914
|
+
:param client_ids_for_oidc: The OIDC client ID for a Amazon Q Business application.
|
|
907
915
|
:param description: A description for the Amazon Q Business application.
|
|
908
916
|
: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.
|
|
909
917
|
:param iam_identity_provider_arn: The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
|
|
@@ -911,7 +919,7 @@ class CfnApplicationProps:
|
|
|
911
919
|
:param identity_type: The authentication type being used by a Amazon Q Business application.
|
|
912
920
|
:param personalization_configuration: Configuration information about chat response personalization. For more information, see `Personalizing chat responses <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html>`_ .
|
|
913
921
|
:param q_apps_configuration: Configuration information about Amazon Q Apps.
|
|
914
|
-
:param quick_sight_configuration:
|
|
922
|
+
:param quick_sight_configuration: The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
|
|
915
923
|
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a `service linked role (SLR) <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions>`_ and use it as the application's role.
|
|
916
924
|
: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: _ . : / = + -
|
|
917
925
|
|
|
@@ -1041,7 +1049,8 @@ class CfnApplicationProps:
|
|
|
1041
1049
|
|
|
1042
1050
|
@builtins.property
|
|
1043
1051
|
def client_ids_for_oidc(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1044
|
-
'''
|
|
1052
|
+
'''The OIDC client ID for a Amazon Q Business application.
|
|
1053
|
+
|
|
1045
1054
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-clientidsforoidc
|
|
1046
1055
|
'''
|
|
1047
1056
|
result = self._values.get("client_ids_for_oidc")
|
|
@@ -1126,7 +1135,8 @@ class CfnApplicationProps:
|
|
|
1126
1135
|
def quick_sight_configuration(
|
|
1127
1136
|
self,
|
|
1128
1137
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnApplication.QuickSightConfigurationProperty]]:
|
|
1129
|
-
'''
|
|
1138
|
+
'''The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
|
|
1139
|
+
|
|
1130
1140
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-quicksightconfiguration
|
|
1131
1141
|
'''
|
|
1132
1142
|
result = self._values.get("quick_sight_configuration")
|
|
@@ -1173,7 +1183,9 @@ class CfnDataAccessor(
|
|
|
1173
1183
|
metaclass=jsii.JSIIMeta,
|
|
1174
1184
|
jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataAccessor",
|
|
1175
1185
|
):
|
|
1176
|
-
'''
|
|
1186
|
+
'''Creates a new data accessor for an ISV to access data from a Amazon Q Business application.
|
|
1187
|
+
|
|
1188
|
+
The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
|
|
1177
1189
|
|
|
1178
1190
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
|
|
1179
1191
|
:cloudformationResource: AWS::QBusiness::DataAccessor
|
|
@@ -1263,11 +1275,11 @@ class CfnDataAccessor(
|
|
|
1263
1275
|
)
|
|
1264
1276
|
)
|
|
1265
1277
|
)],
|
|
1278
|
+
application_id="applicationId",
|
|
1266
1279
|
display_name="displayName",
|
|
1267
1280
|
principal="principal",
|
|
1268
1281
|
|
|
1269
1282
|
# the properties below are optional
|
|
1270
|
-
application_id="applicationId",
|
|
1271
1283
|
tags=[CfnTag(
|
|
1272
1284
|
key="key",
|
|
1273
1285
|
value="value"
|
|
@@ -1281,19 +1293,19 @@ class CfnDataAccessor(
|
|
|
1281
1293
|
id: builtins.str,
|
|
1282
1294
|
*,
|
|
1283
1295
|
action_configurations: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.ActionConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]]],
|
|
1296
|
+
application_id: builtins.str,
|
|
1284
1297
|
display_name: builtins.str,
|
|
1285
1298
|
principal: builtins.str,
|
|
1286
|
-
application_id: typing.Optional[builtins.str] = None,
|
|
1287
1299
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1288
1300
|
) -> None:
|
|
1289
1301
|
'''
|
|
1290
1302
|
:param scope: Scope in which this resource is defined.
|
|
1291
1303
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1292
|
-
:param action_configurations:
|
|
1293
|
-
:param
|
|
1294
|
-
:param
|
|
1295
|
-
:param
|
|
1296
|
-
:param tags:
|
|
1304
|
+
:param action_configurations: A list of action configurations specifying the allowed actions and any associated filters.
|
|
1305
|
+
:param application_id: The unique identifier of the Amazon Q Business application.
|
|
1306
|
+
:param display_name: The friendly name of the data accessor.
|
|
1307
|
+
:param principal: The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
|
|
1308
|
+
:param tags: The tags to associate with the data accessor.
|
|
1297
1309
|
'''
|
|
1298
1310
|
if __debug__:
|
|
1299
1311
|
type_hints = typing.get_type_hints(_typecheckingstub__32b7ecf69912e25edcd2354b3e0497931ea6bf042b1aabc881c8677d2f9be633)
|
|
@@ -1301,9 +1313,9 @@ class CfnDataAccessor(
|
|
|
1301
1313
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
1302
1314
|
props = CfnDataAccessorProps(
|
|
1303
1315
|
action_configurations=action_configurations,
|
|
1316
|
+
application_id=application_id,
|
|
1304
1317
|
display_name=display_name,
|
|
1305
1318
|
principal=principal,
|
|
1306
|
-
application_id=application_id,
|
|
1307
1319
|
tags=tags,
|
|
1308
1320
|
)
|
|
1309
1321
|
|
|
@@ -1342,7 +1354,8 @@ class CfnDataAccessor(
|
|
|
1342
1354
|
@builtins.property
|
|
1343
1355
|
@jsii.member(jsii_name="attrCreatedAt")
|
|
1344
1356
|
def attr_created_at(self) -> builtins.str:
|
|
1345
|
-
'''
|
|
1357
|
+
'''The timestamp when the data accessor was created.
|
|
1358
|
+
|
|
1346
1359
|
:cloudformationAttribute: CreatedAt
|
|
1347
1360
|
'''
|
|
1348
1361
|
return typing.cast(builtins.str, jsii.get(self, "attrCreatedAt"))
|
|
@@ -1350,7 +1363,8 @@ class CfnDataAccessor(
|
|
|
1350
1363
|
@builtins.property
|
|
1351
1364
|
@jsii.member(jsii_name="attrDataAccessorArn")
|
|
1352
1365
|
def attr_data_accessor_arn(self) -> builtins.str:
|
|
1353
|
-
'''
|
|
1366
|
+
'''The Amazon Resource Name (ARN) of the data accessor.
|
|
1367
|
+
|
|
1354
1368
|
:cloudformationAttribute: DataAccessorArn
|
|
1355
1369
|
'''
|
|
1356
1370
|
return typing.cast(builtins.str, jsii.get(self, "attrDataAccessorArn"))
|
|
@@ -1358,7 +1372,8 @@ class CfnDataAccessor(
|
|
|
1358
1372
|
@builtins.property
|
|
1359
1373
|
@jsii.member(jsii_name="attrDataAccessorId")
|
|
1360
1374
|
def attr_data_accessor_id(self) -> builtins.str:
|
|
1361
|
-
'''
|
|
1375
|
+
'''The unique identifier of the data accessor.
|
|
1376
|
+
|
|
1362
1377
|
:cloudformationAttribute: DataAccessorId
|
|
1363
1378
|
'''
|
|
1364
1379
|
return typing.cast(builtins.str, jsii.get(self, "attrDataAccessorId"))
|
|
@@ -1366,7 +1381,8 @@ class CfnDataAccessor(
|
|
|
1366
1381
|
@builtins.property
|
|
1367
1382
|
@jsii.member(jsii_name="attrIdcApplicationArn")
|
|
1368
1383
|
def attr_idc_application_arn(self) -> builtins.str:
|
|
1369
|
-
'''
|
|
1384
|
+
'''The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
|
|
1385
|
+
|
|
1370
1386
|
:cloudformationAttribute: IdcApplicationArn
|
|
1371
1387
|
'''
|
|
1372
1388
|
return typing.cast(builtins.str, jsii.get(self, "attrIdcApplicationArn"))
|
|
@@ -1374,7 +1390,8 @@ class CfnDataAccessor(
|
|
|
1374
1390
|
@builtins.property
|
|
1375
1391
|
@jsii.member(jsii_name="attrUpdatedAt")
|
|
1376
1392
|
def attr_updated_at(self) -> builtins.str:
|
|
1377
|
-
'''
|
|
1393
|
+
'''The timestamp when the data accessor was last updated.
|
|
1394
|
+
|
|
1378
1395
|
:cloudformationAttribute: UpdatedAt
|
|
1379
1396
|
'''
|
|
1380
1397
|
return typing.cast(builtins.str, jsii.get(self, "attrUpdatedAt"))
|
|
@@ -1395,6 +1412,7 @@ class CfnDataAccessor(
|
|
|
1395
1412
|
def action_configurations(
|
|
1396
1413
|
self,
|
|
1397
1414
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.ActionConfigurationProperty"]]]:
|
|
1415
|
+
'''A list of action configurations specifying the allowed actions and any associated filters.'''
|
|
1398
1416
|
return typing.cast(typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.ActionConfigurationProperty"]]], jsii.get(self, "actionConfigurations"))
|
|
1399
1417
|
|
|
1400
1418
|
@action_configurations.setter
|
|
@@ -1407,9 +1425,23 @@ class CfnDataAccessor(
|
|
|
1407
1425
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1408
1426
|
jsii.set(self, "actionConfigurations", value) # pyright: ignore[reportArgumentType]
|
|
1409
1427
|
|
|
1428
|
+
@builtins.property
|
|
1429
|
+
@jsii.member(jsii_name="applicationId")
|
|
1430
|
+
def application_id(self) -> builtins.str:
|
|
1431
|
+
'''The unique identifier of the Amazon Q Business application.'''
|
|
1432
|
+
return typing.cast(builtins.str, jsii.get(self, "applicationId"))
|
|
1433
|
+
|
|
1434
|
+
@application_id.setter
|
|
1435
|
+
def application_id(self, value: builtins.str) -> None:
|
|
1436
|
+
if __debug__:
|
|
1437
|
+
type_hints = typing.get_type_hints(_typecheckingstub__d51b8675a76ff8aa3cd324d2a65da776f4afb1d4600f74839c262998a87adb06)
|
|
1438
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1439
|
+
jsii.set(self, "applicationId", value) # pyright: ignore[reportArgumentType]
|
|
1440
|
+
|
|
1410
1441
|
@builtins.property
|
|
1411
1442
|
@jsii.member(jsii_name="displayName")
|
|
1412
1443
|
def display_name(self) -> builtins.str:
|
|
1444
|
+
'''The friendly name of the data accessor.'''
|
|
1413
1445
|
return typing.cast(builtins.str, jsii.get(self, "displayName"))
|
|
1414
1446
|
|
|
1415
1447
|
@display_name.setter
|
|
@@ -1422,6 +1454,7 @@ class CfnDataAccessor(
|
|
|
1422
1454
|
@builtins.property
|
|
1423
1455
|
@jsii.member(jsii_name="principal")
|
|
1424
1456
|
def principal(self) -> builtins.str:
|
|
1457
|
+
'''The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.'''
|
|
1425
1458
|
return typing.cast(builtins.str, jsii.get(self, "principal"))
|
|
1426
1459
|
|
|
1427
1460
|
@principal.setter
|
|
@@ -1431,21 +1464,10 @@ class CfnDataAccessor(
|
|
|
1431
1464
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1432
1465
|
jsii.set(self, "principal", value) # pyright: ignore[reportArgumentType]
|
|
1433
1466
|
|
|
1434
|
-
@builtins.property
|
|
1435
|
-
@jsii.member(jsii_name="applicationId")
|
|
1436
|
-
def application_id(self) -> typing.Optional[builtins.str]:
|
|
1437
|
-
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "applicationId"))
|
|
1438
|
-
|
|
1439
|
-
@application_id.setter
|
|
1440
|
-
def application_id(self, value: typing.Optional[builtins.str]) -> None:
|
|
1441
|
-
if __debug__:
|
|
1442
|
-
type_hints = typing.get_type_hints(_typecheckingstub__d51b8675a76ff8aa3cd324d2a65da776f4afb1d4600f74839c262998a87adb06)
|
|
1443
|
-
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1444
|
-
jsii.set(self, "applicationId", value) # pyright: ignore[reportArgumentType]
|
|
1445
|
-
|
|
1446
1467
|
@builtins.property
|
|
1447
1468
|
@jsii.member(jsii_name="tags")
|
|
1448
1469
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
1470
|
+
'''The tags to associate with the data accessor.'''
|
|
1449
1471
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
1450
1472
|
|
|
1451
1473
|
@tags.setter
|
|
@@ -1470,9 +1492,10 @@ class CfnDataAccessor(
|
|
|
1470
1492
|
action: builtins.str,
|
|
1471
1493
|
filter_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.ActionFilterConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1472
1494
|
) -> None:
|
|
1473
|
-
'''
|
|
1474
|
-
|
|
1475
|
-
:param
|
|
1495
|
+
'''Specifies an allowed action and its associated filter configuration.
|
|
1496
|
+
|
|
1497
|
+
:param action: The Amazon Q Business action that is allowed.
|
|
1498
|
+
:param filter_configuration: The filter configuration for the action, if any.
|
|
1476
1499
|
|
|
1477
1500
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html
|
|
1478
1501
|
:exampleMetadata: fixture=_generated
|
|
@@ -1573,7 +1596,8 @@ class CfnDataAccessor(
|
|
|
1573
1596
|
|
|
1574
1597
|
@builtins.property
|
|
1575
1598
|
def action(self) -> builtins.str:
|
|
1576
|
-
'''
|
|
1599
|
+
'''The Amazon Q Business action that is allowed.
|
|
1600
|
+
|
|
1577
1601
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-action
|
|
1578
1602
|
'''
|
|
1579
1603
|
result = self._values.get("action")
|
|
@@ -1584,7 +1608,8 @@ class CfnDataAccessor(
|
|
|
1584
1608
|
def filter_configuration(
|
|
1585
1609
|
self,
|
|
1586
1610
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.ActionFilterConfigurationProperty"]]:
|
|
1587
|
-
'''
|
|
1611
|
+
'''The filter configuration for the action, if any.
|
|
1612
|
+
|
|
1588
1613
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration
|
|
1589
1614
|
'''
|
|
1590
1615
|
result = self._values.get("filter_configuration")
|
|
@@ -1612,8 +1637,9 @@ class CfnDataAccessor(
|
|
|
1612
1637
|
*,
|
|
1613
1638
|
document_attribute_filter: typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.AttributeFilterProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
1614
1639
|
) -> None:
|
|
1615
|
-
'''
|
|
1616
|
-
|
|
1640
|
+
'''Specifies filters to apply to an allowed action.
|
|
1641
|
+
|
|
1642
|
+
:param document_attribute_filter: Enables filtering of responses based on document attributes or metadata fields.
|
|
1617
1643
|
|
|
1618
1644
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html
|
|
1619
1645
|
:exampleMetadata: fixture=_generated
|
|
@@ -1708,7 +1734,8 @@ class CfnDataAccessor(
|
|
|
1708
1734
|
def document_attribute_filter(
|
|
1709
1735
|
self,
|
|
1710
1736
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.AttributeFilterProperty"]:
|
|
1711
|
-
'''
|
|
1737
|
+
'''Enables filtering of responses based on document attributes or metadata fields.
|
|
1738
|
+
|
|
1712
1739
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter
|
|
1713
1740
|
'''
|
|
1714
1741
|
result = self._values.get("document_attribute_filter")
|
|
@@ -1757,17 +1784,18 @@ class CfnDataAccessor(
|
|
|
1757
1784
|
not_filter: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.AttributeFilterProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1758
1785
|
or_all_filters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.AttributeFilterProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
1759
1786
|
) -> None:
|
|
1760
|
-
'''
|
|
1761
|
-
|
|
1762
|
-
:param
|
|
1763
|
-
:param
|
|
1764
|
-
:param
|
|
1765
|
-
:param
|
|
1766
|
-
:param
|
|
1767
|
-
:param
|
|
1768
|
-
:param
|
|
1769
|
-
:param
|
|
1770
|
-
:param
|
|
1787
|
+
'''Enables filtering of responses based on document attributes or metadata fields.
|
|
1788
|
+
|
|
1789
|
+
:param and_all_filters: Performs a logical ``AND`` operation on all supplied filters.
|
|
1790
|
+
:param contains_all: Returns ``true`` when a document contains all the specified document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``stringListValue`` .
|
|
1791
|
+
:param contains_any: Returns ``true`` when a document contains any of the specified document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``stringListValue`` .
|
|
1792
|
+
:param equals_to: Performs an equals operation on two document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` , ``longValue`` , ``stringListValue`` and ``stringValue`` .
|
|
1793
|
+
:param greater_than: Performs a greater than operation on two document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1794
|
+
:param greater_than_or_equals: Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1795
|
+
:param less_than: Performs a less than operation on two document attributes or metadata fields. Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1796
|
+
:param less_than_or_equals: Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following `document attribute value type <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1797
|
+
:param not_filter: Performs a logical ``NOT`` operation on all supplied filters.
|
|
1798
|
+
:param or_all_filters: Performs a logical ``OR`` operation on all supplied filters.
|
|
1771
1799
|
|
|
1772
1800
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html
|
|
1773
1801
|
:exampleMetadata: fixture=_generated
|
|
@@ -1887,7 +1915,8 @@ class CfnDataAccessor(
|
|
|
1887
1915
|
def and_all_filters(
|
|
1888
1916
|
self,
|
|
1889
1917
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.AttributeFilterProperty"]]]]:
|
|
1890
|
-
'''
|
|
1918
|
+
'''Performs a logical ``AND`` operation on all supplied filters.
|
|
1919
|
+
|
|
1891
1920
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-andallfilters
|
|
1892
1921
|
'''
|
|
1893
1922
|
result = self._values.get("and_all_filters")
|
|
@@ -1897,7 +1926,10 @@ class CfnDataAccessor(
|
|
|
1897
1926
|
def contains_all(
|
|
1898
1927
|
self,
|
|
1899
1928
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1900
|
-
'''
|
|
1929
|
+
'''Returns ``true`` when a document contains all the specified document attributes or metadata fields.
|
|
1930
|
+
|
|
1931
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``stringListValue`` .
|
|
1932
|
+
|
|
1901
1933
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall
|
|
1902
1934
|
'''
|
|
1903
1935
|
result = self._values.get("contains_all")
|
|
@@ -1907,7 +1939,10 @@ class CfnDataAccessor(
|
|
|
1907
1939
|
def contains_any(
|
|
1908
1940
|
self,
|
|
1909
1941
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1910
|
-
'''
|
|
1942
|
+
'''Returns ``true`` when a document contains any of the specified document attributes or metadata fields.
|
|
1943
|
+
|
|
1944
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``stringListValue`` .
|
|
1945
|
+
|
|
1911
1946
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany
|
|
1912
1947
|
'''
|
|
1913
1948
|
result = self._values.get("contains_any")
|
|
@@ -1917,7 +1952,10 @@ class CfnDataAccessor(
|
|
|
1917
1952
|
def equals_to(
|
|
1918
1953
|
self,
|
|
1919
1954
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1920
|
-
'''
|
|
1955
|
+
'''Performs an equals operation on two document attributes or metadata fields.
|
|
1956
|
+
|
|
1957
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` , ``longValue`` , ``stringListValue`` and ``stringValue`` .
|
|
1958
|
+
|
|
1921
1959
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-equalsto
|
|
1922
1960
|
'''
|
|
1923
1961
|
result = self._values.get("equals_to")
|
|
@@ -1927,7 +1965,10 @@ class CfnDataAccessor(
|
|
|
1927
1965
|
def greater_than(
|
|
1928
1966
|
self,
|
|
1929
1967
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1930
|
-
'''
|
|
1968
|
+
'''Performs a greater than operation on two document attributes or metadata fields.
|
|
1969
|
+
|
|
1970
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1971
|
+
|
|
1931
1972
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan
|
|
1932
1973
|
'''
|
|
1933
1974
|
result = self._values.get("greater_than")
|
|
@@ -1937,7 +1978,10 @@ class CfnDataAccessor(
|
|
|
1937
1978
|
def greater_than_or_equals(
|
|
1938
1979
|
self,
|
|
1939
1980
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1940
|
-
'''
|
|
1981
|
+
'''Performs a greater or equals than operation on two document attributes or metadata fields.
|
|
1982
|
+
|
|
1983
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1984
|
+
|
|
1941
1985
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals
|
|
1942
1986
|
'''
|
|
1943
1987
|
result = self._values.get("greater_than_or_equals")
|
|
@@ -1947,7 +1991,10 @@ class CfnDataAccessor(
|
|
|
1947
1991
|
def less_than(
|
|
1948
1992
|
self,
|
|
1949
1993
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1950
|
-
'''
|
|
1994
|
+
'''Performs a less than operation on two document attributes or metadata fields.
|
|
1995
|
+
|
|
1996
|
+
Supported for the following `document attribute value types <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
1997
|
+
|
|
1951
1998
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan
|
|
1952
1999
|
'''
|
|
1953
2000
|
result = self._values.get("less_than")
|
|
@@ -1957,7 +2004,8 @@ class CfnDataAccessor(
|
|
|
1957
2004
|
def less_than_or_equals(
|
|
1958
2005
|
self,
|
|
1959
2006
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeProperty"]]:
|
|
1960
|
-
'''
|
|
2007
|
+
'''Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following `document attribute value type <https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html>`_ : ``dateValue`` and ``longValue`` .
|
|
2008
|
+
|
|
1961
2009
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals
|
|
1962
2010
|
'''
|
|
1963
2011
|
result = self._values.get("less_than_or_equals")
|
|
@@ -1967,7 +2015,8 @@ class CfnDataAccessor(
|
|
|
1967
2015
|
def not_filter(
|
|
1968
2016
|
self,
|
|
1969
2017
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.AttributeFilterProperty"]]:
|
|
1970
|
-
'''
|
|
2018
|
+
'''Performs a logical ``NOT`` operation on all supplied filters.
|
|
2019
|
+
|
|
1971
2020
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-notfilter
|
|
1972
2021
|
'''
|
|
1973
2022
|
result = self._values.get("not_filter")
|
|
@@ -1977,7 +2026,8 @@ class CfnDataAccessor(
|
|
|
1977
2026
|
def or_all_filters(
|
|
1978
2027
|
self,
|
|
1979
2028
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.AttributeFilterProperty"]]]]:
|
|
1980
|
-
'''
|
|
2029
|
+
'''Performs a logical ``OR`` operation on all supplied filters.
|
|
2030
|
+
|
|
1981
2031
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-orallfilters
|
|
1982
2032
|
'''
|
|
1983
2033
|
result = self._values.get("or_all_filters")
|
|
@@ -2006,9 +2056,10 @@ class CfnDataAccessor(
|
|
|
2006
2056
|
name: builtins.str,
|
|
2007
2057
|
value: typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataAccessor.DocumentAttributeValueProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
2008
2058
|
) -> None:
|
|
2009
|
-
'''
|
|
2010
|
-
|
|
2011
|
-
:param
|
|
2059
|
+
'''A document attribute or metadata field.
|
|
2060
|
+
|
|
2061
|
+
:param name: The identifier for the attribute.
|
|
2062
|
+
:param value: The value of the attribute.
|
|
2012
2063
|
|
|
2013
2064
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html
|
|
2014
2065
|
:exampleMetadata: fixture=_generated
|
|
@@ -2040,7 +2091,8 @@ class CfnDataAccessor(
|
|
|
2040
2091
|
|
|
2041
2092
|
@builtins.property
|
|
2042
2093
|
def name(self) -> builtins.str:
|
|
2043
|
-
'''
|
|
2094
|
+
'''The identifier for the attribute.
|
|
2095
|
+
|
|
2044
2096
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-name
|
|
2045
2097
|
'''
|
|
2046
2098
|
result = self._values.get("name")
|
|
@@ -2051,7 +2103,8 @@ class CfnDataAccessor(
|
|
|
2051
2103
|
def value(
|
|
2052
2104
|
self,
|
|
2053
2105
|
) -> typing.Union[_IResolvable_da3f097b, "CfnDataAccessor.DocumentAttributeValueProperty"]:
|
|
2054
|
-
'''
|
|
2106
|
+
'''The value of the attribute.
|
|
2107
|
+
|
|
2055
2108
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-value
|
|
2056
2109
|
'''
|
|
2057
2110
|
result = self._values.get("value")
|
|
@@ -2088,11 +2141,14 @@ class CfnDataAccessor(
|
|
|
2088
2141
|
string_list_value: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
2089
2142
|
string_value: typing.Optional[builtins.str] = None,
|
|
2090
2143
|
) -> None:
|
|
2091
|
-
'''
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
:param
|
|
2144
|
+
'''The value of a document attribute.
|
|
2145
|
+
|
|
2146
|
+
You can only provide one value for a document attribute.
|
|
2147
|
+
|
|
2148
|
+
: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.
|
|
2149
|
+
:param long_value: A long integer value.
|
|
2150
|
+
:param string_list_value: A list of strings.
|
|
2151
|
+
:param string_value: A string.
|
|
2096
2152
|
|
|
2097
2153
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html
|
|
2098
2154
|
:exampleMetadata: fixture=_generated
|
|
@@ -2128,7 +2184,10 @@ class CfnDataAccessor(
|
|
|
2128
2184
|
|
|
2129
2185
|
@builtins.property
|
|
2130
2186
|
def date_value(self) -> typing.Optional[builtins.str]:
|
|
2131
|
-
'''
|
|
2187
|
+
'''A date expressed as an ISO 8601 string.
|
|
2188
|
+
|
|
2189
|
+
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.
|
|
2190
|
+
|
|
2132
2191
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-datevalue
|
|
2133
2192
|
'''
|
|
2134
2193
|
result = self._values.get("date_value")
|
|
@@ -2136,7 +2195,8 @@ class CfnDataAccessor(
|
|
|
2136
2195
|
|
|
2137
2196
|
@builtins.property
|
|
2138
2197
|
def long_value(self) -> typing.Optional[jsii.Number]:
|
|
2139
|
-
'''
|
|
2198
|
+
'''A long integer value.
|
|
2199
|
+
|
|
2140
2200
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue
|
|
2141
2201
|
'''
|
|
2142
2202
|
result = self._values.get("long_value")
|
|
@@ -2144,7 +2204,8 @@ class CfnDataAccessor(
|
|
|
2144
2204
|
|
|
2145
2205
|
@builtins.property
|
|
2146
2206
|
def string_list_value(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
2147
|
-
'''
|
|
2207
|
+
'''A list of strings.
|
|
2208
|
+
|
|
2148
2209
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue
|
|
2149
2210
|
'''
|
|
2150
2211
|
result = self._values.get("string_list_value")
|
|
@@ -2152,7 +2213,8 @@ class CfnDataAccessor(
|
|
|
2152
2213
|
|
|
2153
2214
|
@builtins.property
|
|
2154
2215
|
def string_value(self) -> typing.Optional[builtins.str]:
|
|
2155
|
-
'''
|
|
2216
|
+
'''A string.
|
|
2217
|
+
|
|
2156
2218
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue
|
|
2157
2219
|
'''
|
|
2158
2220
|
result = self._values.get("string_value")
|
|
@@ -2175,9 +2237,9 @@ class CfnDataAccessor(
|
|
|
2175
2237
|
jsii_struct_bases=[],
|
|
2176
2238
|
name_mapping={
|
|
2177
2239
|
"action_configurations": "actionConfigurations",
|
|
2240
|
+
"application_id": "applicationId",
|
|
2178
2241
|
"display_name": "displayName",
|
|
2179
2242
|
"principal": "principal",
|
|
2180
|
-
"application_id": "applicationId",
|
|
2181
2243
|
"tags": "tags",
|
|
2182
2244
|
},
|
|
2183
2245
|
)
|
|
@@ -2186,18 +2248,18 @@ class CfnDataAccessorProps:
|
|
|
2186
2248
|
self,
|
|
2187
2249
|
*,
|
|
2188
2250
|
action_configurations: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataAccessor.ActionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
2251
|
+
application_id: builtins.str,
|
|
2189
2252
|
display_name: builtins.str,
|
|
2190
2253
|
principal: builtins.str,
|
|
2191
|
-
application_id: typing.Optional[builtins.str] = None,
|
|
2192
2254
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2193
2255
|
) -> None:
|
|
2194
2256
|
'''Properties for defining a ``CfnDataAccessor``.
|
|
2195
2257
|
|
|
2196
|
-
:param action_configurations:
|
|
2197
|
-
:param
|
|
2198
|
-
:param
|
|
2199
|
-
:param
|
|
2200
|
-
:param tags:
|
|
2258
|
+
:param action_configurations: A list of action configurations specifying the allowed actions and any associated filters.
|
|
2259
|
+
:param application_id: The unique identifier of the Amazon Q Business application.
|
|
2260
|
+
:param display_name: The friendly name of the data accessor.
|
|
2261
|
+
:param principal: The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
|
|
2262
|
+
:param tags: The tags to associate with the data accessor.
|
|
2201
2263
|
|
|
2202
2264
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
|
|
2203
2265
|
:exampleMetadata: fixture=_generated
|
|
@@ -2286,11 +2348,11 @@ class CfnDataAccessorProps:
|
|
|
2286
2348
|
)
|
|
2287
2349
|
)
|
|
2288
2350
|
)],
|
|
2351
|
+
application_id="applicationId",
|
|
2289
2352
|
display_name="displayName",
|
|
2290
2353
|
principal="principal",
|
|
2291
2354
|
|
|
2292
2355
|
# the properties below are optional
|
|
2293
|
-
application_id="applicationId",
|
|
2294
2356
|
tags=[CfnTag(
|
|
2295
2357
|
key="key",
|
|
2296
2358
|
value="value"
|
|
@@ -2300,17 +2362,16 @@ class CfnDataAccessorProps:
|
|
|
2300
2362
|
if __debug__:
|
|
2301
2363
|
type_hints = typing.get_type_hints(_typecheckingstub__4dfde2d4c17793fa3cb9793a9171b9042ac55727b3f0c3a17f1606cab5545458)
|
|
2302
2364
|
check_type(argname="argument action_configurations", value=action_configurations, expected_type=type_hints["action_configurations"])
|
|
2365
|
+
check_type(argname="argument application_id", value=application_id, expected_type=type_hints["application_id"])
|
|
2303
2366
|
check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
|
|
2304
2367
|
check_type(argname="argument principal", value=principal, expected_type=type_hints["principal"])
|
|
2305
|
-
check_type(argname="argument application_id", value=application_id, expected_type=type_hints["application_id"])
|
|
2306
2368
|
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
2307
2369
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
2308
2370
|
"action_configurations": action_configurations,
|
|
2371
|
+
"application_id": application_id,
|
|
2309
2372
|
"display_name": display_name,
|
|
2310
2373
|
"principal": principal,
|
|
2311
2374
|
}
|
|
2312
|
-
if application_id is not None:
|
|
2313
|
-
self._values["application_id"] = application_id
|
|
2314
2375
|
if tags is not None:
|
|
2315
2376
|
self._values["tags"] = tags
|
|
2316
2377
|
|
|
@@ -2318,7 +2379,8 @@ class CfnDataAccessorProps:
|
|
|
2318
2379
|
def action_configurations(
|
|
2319
2380
|
self,
|
|
2320
2381
|
) -> typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDataAccessor.ActionConfigurationProperty]]]:
|
|
2321
|
-
'''
|
|
2382
|
+
'''A list of action configurations specifying the allowed actions and any associated filters.
|
|
2383
|
+
|
|
2322
2384
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-actionconfigurations
|
|
2323
2385
|
'''
|
|
2324
2386
|
result = self._values.get("action_configurations")
|
|
@@ -2326,8 +2388,19 @@ class CfnDataAccessorProps:
|
|
|
2326
2388
|
return typing.cast(typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnDataAccessor.ActionConfigurationProperty]]], result)
|
|
2327
2389
|
|
|
2328
2390
|
@builtins.property
|
|
2329
|
-
def
|
|
2391
|
+
def application_id(self) -> builtins.str:
|
|
2392
|
+
'''The unique identifier of the Amazon Q Business application.
|
|
2393
|
+
|
|
2394
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-applicationid
|
|
2330
2395
|
'''
|
|
2396
|
+
result = self._values.get("application_id")
|
|
2397
|
+
assert result is not None, "Required property 'application_id' is missing"
|
|
2398
|
+
return typing.cast(builtins.str, result)
|
|
2399
|
+
|
|
2400
|
+
@builtins.property
|
|
2401
|
+
def display_name(self) -> builtins.str:
|
|
2402
|
+
'''The friendly name of the data accessor.
|
|
2403
|
+
|
|
2331
2404
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-displayname
|
|
2332
2405
|
'''
|
|
2333
2406
|
result = self._values.get("display_name")
|
|
@@ -2336,24 +2409,18 @@ class CfnDataAccessorProps:
|
|
|
2336
2409
|
|
|
2337
2410
|
@builtins.property
|
|
2338
2411
|
def principal(self) -> builtins.str:
|
|
2339
|
-
'''
|
|
2412
|
+
'''The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
|
|
2413
|
+
|
|
2340
2414
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-principal
|
|
2341
2415
|
'''
|
|
2342
2416
|
result = self._values.get("principal")
|
|
2343
2417
|
assert result is not None, "Required property 'principal' is missing"
|
|
2344
2418
|
return typing.cast(builtins.str, result)
|
|
2345
2419
|
|
|
2346
|
-
@builtins.property
|
|
2347
|
-
def application_id(self) -> typing.Optional[builtins.str]:
|
|
2348
|
-
'''
|
|
2349
|
-
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-applicationid
|
|
2350
|
-
'''
|
|
2351
|
-
result = self._values.get("application_id")
|
|
2352
|
-
return typing.cast(typing.Optional[builtins.str], result)
|
|
2353
|
-
|
|
2354
2420
|
@builtins.property
|
|
2355
2421
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
2356
|
-
'''
|
|
2422
|
+
'''The tags to associate with the data accessor.
|
|
2423
|
+
|
|
2357
2424
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-tags
|
|
2358
2425
|
'''
|
|
2359
2426
|
result = self._values.get("tags")
|
|
@@ -2464,6 +2531,11 @@ class CfnDataSource(
|
|
|
2464
2531
|
s3_bucket_name="s3BucketName"
|
|
2465
2532
|
)
|
|
2466
2533
|
),
|
|
2534
|
+
media_extraction_configuration=qbusiness.CfnDataSource.MediaExtractionConfigurationProperty(
|
|
2535
|
+
image_extraction_configuration=qbusiness.CfnDataSource.ImageExtractionConfigurationProperty(
|
|
2536
|
+
image_extraction_status="imageExtractionStatus"
|
|
2537
|
+
)
|
|
2538
|
+
),
|
|
2467
2539
|
role_arn="roleArn",
|
|
2468
2540
|
sync_schedule="syncSchedule",
|
|
2469
2541
|
tags=[CfnTag(
|
|
@@ -2488,6 +2560,7 @@ class CfnDataSource(
|
|
|
2488
2560
|
index_id: builtins.str,
|
|
2489
2561
|
description: typing.Optional[builtins.str] = None,
|
|
2490
2562
|
document_enrichment_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.DocumentEnrichmentConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2563
|
+
media_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.MediaExtractionConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
2491
2564
|
role_arn: typing.Optional[builtins.str] = None,
|
|
2492
2565
|
sync_schedule: typing.Optional[builtins.str] = None,
|
|
2493
2566
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -2502,6 +2575,7 @@ class CfnDataSource(
|
|
|
2502
2575
|
:param index_id: The identifier of the index the data source is attached to.
|
|
2503
2576
|
:param description: A description for the data source connector.
|
|
2504
2577
|
: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>`_ .
|
|
2578
|
+
:param media_extraction_configuration: The configuration for extracting information from media in documents.
|
|
2505
2579
|
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
|
|
2506
2580
|
: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.
|
|
2507
2581
|
: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: _ . : / = + -
|
|
@@ -2518,6 +2592,7 @@ class CfnDataSource(
|
|
|
2518
2592
|
index_id=index_id,
|
|
2519
2593
|
description=description,
|
|
2520
2594
|
document_enrichment_configuration=document_enrichment_configuration,
|
|
2595
|
+
media_extraction_configuration=media_extraction_configuration,
|
|
2521
2596
|
role_arn=role_arn,
|
|
2522
2597
|
sync_schedule=sync_schedule,
|
|
2523
2598
|
tags=tags,
|
|
@@ -2704,6 +2779,24 @@ class CfnDataSource(
|
|
|
2704
2779
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
2705
2780
|
jsii.set(self, "documentEnrichmentConfiguration", value) # pyright: ignore[reportArgumentType]
|
|
2706
2781
|
|
|
2782
|
+
@builtins.property
|
|
2783
|
+
@jsii.member(jsii_name="mediaExtractionConfiguration")
|
|
2784
|
+
def media_extraction_configuration(
|
|
2785
|
+
self,
|
|
2786
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.MediaExtractionConfigurationProperty"]]:
|
|
2787
|
+
'''The configuration for extracting information from media in documents.'''
|
|
2788
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.MediaExtractionConfigurationProperty"]], jsii.get(self, "mediaExtractionConfiguration"))
|
|
2789
|
+
|
|
2790
|
+
@media_extraction_configuration.setter
|
|
2791
|
+
def media_extraction_configuration(
|
|
2792
|
+
self,
|
|
2793
|
+
value: typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.MediaExtractionConfigurationProperty"]],
|
|
2794
|
+
) -> None:
|
|
2795
|
+
if __debug__:
|
|
2796
|
+
type_hints = typing.get_type_hints(_typecheckingstub__61d3297e7877958a257749ac6dada8495933c305bc80bd233f5feb0fe4960a81)
|
|
2797
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
2798
|
+
jsii.set(self, "mediaExtractionConfiguration", value) # pyright: ignore[reportArgumentType]
|
|
2799
|
+
|
|
2707
2800
|
@builtins.property
|
|
2708
2801
|
@jsii.member(jsii_name="roleArn")
|
|
2709
2802
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
@@ -3461,6 +3554,60 @@ class CfnDataSource(
|
|
|
3461
3554
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
3462
3555
|
)
|
|
3463
3556
|
|
|
3557
|
+
@jsii.data_type(
|
|
3558
|
+
jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataSource.ImageExtractionConfigurationProperty",
|
|
3559
|
+
jsii_struct_bases=[],
|
|
3560
|
+
name_mapping={"image_extraction_status": "imageExtractionStatus"},
|
|
3561
|
+
)
|
|
3562
|
+
class ImageExtractionConfigurationProperty:
|
|
3563
|
+
def __init__(self, *, image_extraction_status: builtins.str) -> None:
|
|
3564
|
+
'''The configuration for extracting semantic meaning from images in documents.
|
|
3565
|
+
|
|
3566
|
+
For more information, see `Extracting semantic meaning from images and visuals <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html>`_ .
|
|
3567
|
+
|
|
3568
|
+
:param image_extraction_status: Specify whether to extract semantic meaning from images and visuals from documents.
|
|
3569
|
+
|
|
3570
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionconfiguration.html
|
|
3571
|
+
:exampleMetadata: fixture=_generated
|
|
3572
|
+
|
|
3573
|
+
Example::
|
|
3574
|
+
|
|
3575
|
+
# The code below shows an example of how to instantiate this type.
|
|
3576
|
+
# The values are placeholders you should change.
|
|
3577
|
+
from aws_cdk import aws_qbusiness as qbusiness
|
|
3578
|
+
|
|
3579
|
+
image_extraction_configuration_property = qbusiness.CfnDataSource.ImageExtractionConfigurationProperty(
|
|
3580
|
+
image_extraction_status="imageExtractionStatus"
|
|
3581
|
+
)
|
|
3582
|
+
'''
|
|
3583
|
+
if __debug__:
|
|
3584
|
+
type_hints = typing.get_type_hints(_typecheckingstub__40e7364b05e4957f04891e99e2b4de3fa819ddcc49a154a8118fdf016503e031)
|
|
3585
|
+
check_type(argname="argument image_extraction_status", value=image_extraction_status, expected_type=type_hints["image_extraction_status"])
|
|
3586
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
3587
|
+
"image_extraction_status": image_extraction_status,
|
|
3588
|
+
}
|
|
3589
|
+
|
|
3590
|
+
@builtins.property
|
|
3591
|
+
def image_extraction_status(self) -> builtins.str:
|
|
3592
|
+
'''Specify whether to extract semantic meaning from images and visuals from documents.
|
|
3593
|
+
|
|
3594
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-imageextractionconfiguration.html#cfn-qbusiness-datasource-imageextractionconfiguration-imageextractionstatus
|
|
3595
|
+
'''
|
|
3596
|
+
result = self._values.get("image_extraction_status")
|
|
3597
|
+
assert result is not None, "Required property 'image_extraction_status' is missing"
|
|
3598
|
+
return typing.cast(builtins.str, result)
|
|
3599
|
+
|
|
3600
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
3601
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
3602
|
+
|
|
3603
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
3604
|
+
return not (rhs == self)
|
|
3605
|
+
|
|
3606
|
+
def __repr__(self) -> str:
|
|
3607
|
+
return "ImageExtractionConfigurationProperty(%s)" % ", ".join(
|
|
3608
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
3609
|
+
)
|
|
3610
|
+
|
|
3464
3611
|
@jsii.data_type(
|
|
3465
3612
|
jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataSource.InlineDocumentEnrichmentConfigurationProperty",
|
|
3466
3613
|
jsii_struct_bases=[],
|
|
@@ -3582,6 +3729,69 @@ class CfnDataSource(
|
|
|
3582
3729
|
k + "=" + repr(v) for k, v in self._values.items()
|
|
3583
3730
|
)
|
|
3584
3731
|
|
|
3732
|
+
@jsii.data_type(
|
|
3733
|
+
jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataSource.MediaExtractionConfigurationProperty",
|
|
3734
|
+
jsii_struct_bases=[],
|
|
3735
|
+
name_mapping={
|
|
3736
|
+
"image_extraction_configuration": "imageExtractionConfiguration",
|
|
3737
|
+
},
|
|
3738
|
+
)
|
|
3739
|
+
class MediaExtractionConfigurationProperty:
|
|
3740
|
+
def __init__(
|
|
3741
|
+
self,
|
|
3742
|
+
*,
|
|
3743
|
+
image_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDataSource.ImageExtractionConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3744
|
+
) -> None:
|
|
3745
|
+
'''The configuration for extracting information from media in documents.
|
|
3746
|
+
|
|
3747
|
+
:param image_extraction_configuration: The configuration for extracting semantic meaning from images in documents. For more information, see `Extracting semantic meaning from images and visuals <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html>`_ .
|
|
3748
|
+
|
|
3749
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html
|
|
3750
|
+
:exampleMetadata: fixture=_generated
|
|
3751
|
+
|
|
3752
|
+
Example::
|
|
3753
|
+
|
|
3754
|
+
# The code below shows an example of how to instantiate this type.
|
|
3755
|
+
# The values are placeholders you should change.
|
|
3756
|
+
from aws_cdk import aws_qbusiness as qbusiness
|
|
3757
|
+
|
|
3758
|
+
media_extraction_configuration_property = qbusiness.CfnDataSource.MediaExtractionConfigurationProperty(
|
|
3759
|
+
image_extraction_configuration=qbusiness.CfnDataSource.ImageExtractionConfigurationProperty(
|
|
3760
|
+
image_extraction_status="imageExtractionStatus"
|
|
3761
|
+
)
|
|
3762
|
+
)
|
|
3763
|
+
'''
|
|
3764
|
+
if __debug__:
|
|
3765
|
+
type_hints = typing.get_type_hints(_typecheckingstub__45d49817772a3b69716257ee4a29683841b4420b41115ce7a18bc124fe4f9f87)
|
|
3766
|
+
check_type(argname="argument image_extraction_configuration", value=image_extraction_configuration, expected_type=type_hints["image_extraction_configuration"])
|
|
3767
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
3768
|
+
if image_extraction_configuration is not None:
|
|
3769
|
+
self._values["image_extraction_configuration"] = image_extraction_configuration
|
|
3770
|
+
|
|
3771
|
+
@builtins.property
|
|
3772
|
+
def image_extraction_configuration(
|
|
3773
|
+
self,
|
|
3774
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.ImageExtractionConfigurationProperty"]]:
|
|
3775
|
+
'''The configuration for extracting semantic meaning from images in documents.
|
|
3776
|
+
|
|
3777
|
+
For more information, see `Extracting semantic meaning from images and visuals <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html>`_ .
|
|
3778
|
+
|
|
3779
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-datasource-mediaextractionconfiguration.html#cfn-qbusiness-datasource-mediaextractionconfiguration-imageextractionconfiguration
|
|
3780
|
+
'''
|
|
3781
|
+
result = self._values.get("image_extraction_configuration")
|
|
3782
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDataSource.ImageExtractionConfigurationProperty"]], result)
|
|
3783
|
+
|
|
3784
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
3785
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
3786
|
+
|
|
3787
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
3788
|
+
return not (rhs == self)
|
|
3789
|
+
|
|
3790
|
+
def __repr__(self) -> str:
|
|
3791
|
+
return "MediaExtractionConfigurationProperty(%s)" % ", ".join(
|
|
3792
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
3793
|
+
)
|
|
3794
|
+
|
|
3585
3795
|
|
|
3586
3796
|
@jsii.data_type(
|
|
3587
3797
|
jsii_type="aws-cdk-lib.aws_qbusiness.CfnDataSourceProps",
|
|
@@ -3593,6 +3803,7 @@ class CfnDataSource(
|
|
|
3593
3803
|
"index_id": "indexId",
|
|
3594
3804
|
"description": "description",
|
|
3595
3805
|
"document_enrichment_configuration": "documentEnrichmentConfiguration",
|
|
3806
|
+
"media_extraction_configuration": "mediaExtractionConfiguration",
|
|
3596
3807
|
"role_arn": "roleArn",
|
|
3597
3808
|
"sync_schedule": "syncSchedule",
|
|
3598
3809
|
"tags": "tags",
|
|
@@ -3609,6 +3820,7 @@ class CfnDataSourceProps:
|
|
|
3609
3820
|
index_id: builtins.str,
|
|
3610
3821
|
description: typing.Optional[builtins.str] = None,
|
|
3611
3822
|
document_enrichment_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.DocumentEnrichmentConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3823
|
+
media_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.MediaExtractionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3612
3824
|
role_arn: typing.Optional[builtins.str] = None,
|
|
3613
3825
|
sync_schedule: typing.Optional[builtins.str] = None,
|
|
3614
3826
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -3622,6 +3834,7 @@ class CfnDataSourceProps:
|
|
|
3622
3834
|
:param index_id: The identifier of the index the data source is attached to.
|
|
3623
3835
|
:param description: A description for the data source connector.
|
|
3624
3836
|
: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>`_ .
|
|
3837
|
+
:param media_extraction_configuration: The configuration for extracting information from media in documents.
|
|
3625
3838
|
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
|
|
3626
3839
|
: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.
|
|
3627
3840
|
: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: _ . : / = + -
|
|
@@ -3709,6 +3922,11 @@ class CfnDataSourceProps:
|
|
|
3709
3922
|
s3_bucket_name="s3BucketName"
|
|
3710
3923
|
)
|
|
3711
3924
|
),
|
|
3925
|
+
media_extraction_configuration=qbusiness.CfnDataSource.MediaExtractionConfigurationProperty(
|
|
3926
|
+
image_extraction_configuration=qbusiness.CfnDataSource.ImageExtractionConfigurationProperty(
|
|
3927
|
+
image_extraction_status="imageExtractionStatus"
|
|
3928
|
+
)
|
|
3929
|
+
),
|
|
3712
3930
|
role_arn="roleArn",
|
|
3713
3931
|
sync_schedule="syncSchedule",
|
|
3714
3932
|
tags=[CfnTag(
|
|
@@ -3729,6 +3947,7 @@ class CfnDataSourceProps:
|
|
|
3729
3947
|
check_type(argname="argument index_id", value=index_id, expected_type=type_hints["index_id"])
|
|
3730
3948
|
check_type(argname="argument description", value=description, expected_type=type_hints["description"])
|
|
3731
3949
|
check_type(argname="argument document_enrichment_configuration", value=document_enrichment_configuration, expected_type=type_hints["document_enrichment_configuration"])
|
|
3950
|
+
check_type(argname="argument media_extraction_configuration", value=media_extraction_configuration, expected_type=type_hints["media_extraction_configuration"])
|
|
3732
3951
|
check_type(argname="argument role_arn", value=role_arn, expected_type=type_hints["role_arn"])
|
|
3733
3952
|
check_type(argname="argument sync_schedule", value=sync_schedule, expected_type=type_hints["sync_schedule"])
|
|
3734
3953
|
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
@@ -3743,6 +3962,8 @@ class CfnDataSourceProps:
|
|
|
3743
3962
|
self._values["description"] = description
|
|
3744
3963
|
if document_enrichment_configuration is not None:
|
|
3745
3964
|
self._values["document_enrichment_configuration"] = document_enrichment_configuration
|
|
3965
|
+
if media_extraction_configuration is not None:
|
|
3966
|
+
self._values["media_extraction_configuration"] = media_extraction_configuration
|
|
3746
3967
|
if role_arn is not None:
|
|
3747
3968
|
self._values["role_arn"] = role_arn
|
|
3748
3969
|
if sync_schedule is not None:
|
|
@@ -3826,6 +4047,17 @@ class CfnDataSourceProps:
|
|
|
3826
4047
|
result = self._values.get("document_enrichment_configuration")
|
|
3827
4048
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.DocumentEnrichmentConfigurationProperty]], result)
|
|
3828
4049
|
|
|
4050
|
+
@builtins.property
|
|
4051
|
+
def media_extraction_configuration(
|
|
4052
|
+
self,
|
|
4053
|
+
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.MediaExtractionConfigurationProperty]]:
|
|
4054
|
+
'''The configuration for extracting information from media in documents.
|
|
4055
|
+
|
|
4056
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-mediaextractionconfiguration
|
|
4057
|
+
'''
|
|
4058
|
+
result = self._values.get("media_extraction_configuration")
|
|
4059
|
+
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.MediaExtractionConfigurationProperty]], result)
|
|
4060
|
+
|
|
3829
4061
|
@builtins.property
|
|
3830
4062
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
3831
4063
|
'''The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
|
|
@@ -4627,7 +4859,9 @@ class CfnPermission(
|
|
|
4627
4859
|
metaclass=jsii.JSIIMeta,
|
|
4628
4860
|
jsii_type="aws-cdk-lib.aws_qbusiness.CfnPermission",
|
|
4629
4861
|
):
|
|
4630
|
-
'''
|
|
4862
|
+
'''Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.
|
|
4863
|
+
|
|
4864
|
+
This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
|
|
4631
4865
|
|
|
4632
4866
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html
|
|
4633
4867
|
:cloudformationResource: AWS::QBusiness::Permission
|
|
@@ -4660,10 +4894,10 @@ class CfnPermission(
|
|
|
4660
4894
|
'''
|
|
4661
4895
|
:param scope: Scope in which this resource is defined.
|
|
4662
4896
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4663
|
-
:param actions:
|
|
4664
|
-
:param application_id:
|
|
4665
|
-
:param principal:
|
|
4666
|
-
:param statement_id:
|
|
4897
|
+
:param actions: The list of Amazon Q Business actions that the ISV is allowed to perform.
|
|
4898
|
+
:param application_id: The unique identifier of the Amazon Q Business application.
|
|
4899
|
+
:param principal: Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
|
|
4900
|
+
:param statement_id: A unique identifier for the policy statement.
|
|
4667
4901
|
'''
|
|
4668
4902
|
if __debug__:
|
|
4669
4903
|
type_hints = typing.get_type_hints(_typecheckingstub__aa8b9992ffebedf4dda280be4bd0aa5dade8d62a6c092d850b1b1bb8df042ee8)
|
|
@@ -4716,6 +4950,7 @@ class CfnPermission(
|
|
|
4716
4950
|
@builtins.property
|
|
4717
4951
|
@jsii.member(jsii_name="actions")
|
|
4718
4952
|
def actions(self) -> typing.List[builtins.str]:
|
|
4953
|
+
'''The list of Amazon Q Business actions that the ISV is allowed to perform.'''
|
|
4719
4954
|
return typing.cast(typing.List[builtins.str], jsii.get(self, "actions"))
|
|
4720
4955
|
|
|
4721
4956
|
@actions.setter
|
|
@@ -4728,6 +4963,7 @@ class CfnPermission(
|
|
|
4728
4963
|
@builtins.property
|
|
4729
4964
|
@jsii.member(jsii_name="applicationId")
|
|
4730
4965
|
def application_id(self) -> builtins.str:
|
|
4966
|
+
'''The unique identifier of the Amazon Q Business application.'''
|
|
4731
4967
|
return typing.cast(builtins.str, jsii.get(self, "applicationId"))
|
|
4732
4968
|
|
|
4733
4969
|
@application_id.setter
|
|
@@ -4740,6 +4976,7 @@ class CfnPermission(
|
|
|
4740
4976
|
@builtins.property
|
|
4741
4977
|
@jsii.member(jsii_name="principal")
|
|
4742
4978
|
def principal(self) -> builtins.str:
|
|
4979
|
+
'''Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.'''
|
|
4743
4980
|
return typing.cast(builtins.str, jsii.get(self, "principal"))
|
|
4744
4981
|
|
|
4745
4982
|
@principal.setter
|
|
@@ -4752,6 +4989,7 @@ class CfnPermission(
|
|
|
4752
4989
|
@builtins.property
|
|
4753
4990
|
@jsii.member(jsii_name="statementId")
|
|
4754
4991
|
def statement_id(self) -> builtins.str:
|
|
4992
|
+
'''A unique identifier for the policy statement.'''
|
|
4755
4993
|
return typing.cast(builtins.str, jsii.get(self, "statementId"))
|
|
4756
4994
|
|
|
4757
4995
|
@statement_id.setter
|
|
@@ -4783,10 +5021,10 @@ class CfnPermissionProps:
|
|
|
4783
5021
|
) -> None:
|
|
4784
5022
|
'''Properties for defining a ``CfnPermission``.
|
|
4785
5023
|
|
|
4786
|
-
:param actions:
|
|
4787
|
-
:param application_id:
|
|
4788
|
-
:param principal:
|
|
4789
|
-
:param statement_id:
|
|
5024
|
+
:param actions: The list of Amazon Q Business actions that the ISV is allowed to perform.
|
|
5025
|
+
:param application_id: The unique identifier of the Amazon Q Business application.
|
|
5026
|
+
:param principal: Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
|
|
5027
|
+
:param statement_id: A unique identifier for the policy statement.
|
|
4790
5028
|
|
|
4791
5029
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html
|
|
4792
5030
|
:exampleMetadata: fixture=_generated
|
|
@@ -4819,7 +5057,8 @@ class CfnPermissionProps:
|
|
|
4819
5057
|
|
|
4820
5058
|
@builtins.property
|
|
4821
5059
|
def actions(self) -> typing.List[builtins.str]:
|
|
4822
|
-
'''
|
|
5060
|
+
'''The list of Amazon Q Business actions that the ISV is allowed to perform.
|
|
5061
|
+
|
|
4823
5062
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-actions
|
|
4824
5063
|
'''
|
|
4825
5064
|
result = self._values.get("actions")
|
|
@@ -4828,7 +5067,8 @@ class CfnPermissionProps:
|
|
|
4828
5067
|
|
|
4829
5068
|
@builtins.property
|
|
4830
5069
|
def application_id(self) -> builtins.str:
|
|
4831
|
-
'''
|
|
5070
|
+
'''The unique identifier of the Amazon Q Business application.
|
|
5071
|
+
|
|
4832
5072
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-applicationid
|
|
4833
5073
|
'''
|
|
4834
5074
|
result = self._values.get("application_id")
|
|
@@ -4837,7 +5077,8 @@ class CfnPermissionProps:
|
|
|
4837
5077
|
|
|
4838
5078
|
@builtins.property
|
|
4839
5079
|
def principal(self) -> builtins.str:
|
|
4840
|
-
'''
|
|
5080
|
+
'''Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
|
|
5081
|
+
|
|
4841
5082
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-principal
|
|
4842
5083
|
'''
|
|
4843
5084
|
result = self._values.get("principal")
|
|
@@ -4846,7 +5087,8 @@ class CfnPermissionProps:
|
|
|
4846
5087
|
|
|
4847
5088
|
@builtins.property
|
|
4848
5089
|
def statement_id(self) -> builtins.str:
|
|
4849
|
-
'''
|
|
5090
|
+
'''A unique identifier for the policy statement.
|
|
5091
|
+
|
|
4850
5092
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-permission.html#cfn-qbusiness-permission-statementid
|
|
4851
5093
|
'''
|
|
4852
5094
|
result = self._values.get("statement_id")
|
|
@@ -5437,8 +5679,8 @@ class CfnPlugin(
|
|
|
5437
5679
|
|
|
5438
5680
|
: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.
|
|
5439
5681
|
:param secret_arn: The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
|
|
5440
|
-
:param authorization_url:
|
|
5441
|
-
:param token_url:
|
|
5682
|
+
:param authorization_url: The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
|
|
5683
|
+
:param token_url: The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
|
|
5442
5684
|
|
|
5443
5685
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html
|
|
5444
5686
|
:exampleMetadata: fixture=_generated
|
|
@@ -5495,7 +5737,8 @@ class CfnPlugin(
|
|
|
5495
5737
|
|
|
5496
5738
|
@builtins.property
|
|
5497
5739
|
def authorization_url(self) -> typing.Optional[builtins.str]:
|
|
5498
|
-
'''
|
|
5740
|
+
'''The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
|
|
5741
|
+
|
|
5499
5742
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-authorizationurl
|
|
5500
5743
|
'''
|
|
5501
5744
|
result = self._values.get("authorization_url")
|
|
@@ -5503,7 +5746,8 @@ class CfnPlugin(
|
|
|
5503
5746
|
|
|
5504
5747
|
@builtins.property
|
|
5505
5748
|
def token_url(self) -> typing.Optional[builtins.str]:
|
|
5506
|
-
'''
|
|
5749
|
+
'''The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
|
|
5750
|
+
|
|
5507
5751
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-oauth2clientcredentialconfiguration.html#cfn-qbusiness-plugin-oauth2clientcredentialconfiguration-tokenurl
|
|
5508
5752
|
'''
|
|
5509
5753
|
result = self._values.get("token_url")
|
|
@@ -6559,7 +6803,7 @@ class CfnWebExperience(
|
|
|
6559
6803
|
:param scope: Scope in which this resource is defined.
|
|
6560
6804
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6561
6805
|
:param application_id: The identifier of the Amazon Q Business web experience.
|
|
6562
|
-
:param customization_configuration:
|
|
6806
|
+
:param customization_configuration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
|
|
6563
6807
|
:param identity_provider_configuration: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
6564
6808
|
:param origins: Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol ( ``http/https`` ), the domain name, and the port number (if specified). .. epigraph:: You must only submit a *base URL* and not a full path. For example, ``https://docs.aws.amazon.com`` .
|
|
6565
6809
|
:param role_arn: The Amazon Resource Name (ARN) of the service role attached to your web experience. .. epigraph:: You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
|
|
@@ -6703,6 +6947,7 @@ class CfnWebExperience(
|
|
|
6703
6947
|
def customization_configuration(
|
|
6704
6948
|
self,
|
|
6705
6949
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnWebExperience.CustomizationConfigurationProperty"]]:
|
|
6950
|
+
'''Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.'''
|
|
6706
6951
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnWebExperience.CustomizationConfigurationProperty"]], jsii.get(self, "customizationConfiguration"))
|
|
6707
6952
|
|
|
6708
6953
|
@customization_configuration.setter
|
|
@@ -6843,11 +7088,12 @@ class CfnWebExperience(
|
|
|
6843
7088
|
font_url: typing.Optional[builtins.str] = None,
|
|
6844
7089
|
logo_url: typing.Optional[builtins.str] = None,
|
|
6845
7090
|
) -> None:
|
|
6846
|
-
'''
|
|
6847
|
-
|
|
6848
|
-
:param
|
|
6849
|
-
:param
|
|
6850
|
-
:param
|
|
7091
|
+
'''Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
|
|
7092
|
+
|
|
7093
|
+
:param custom_css_url: Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
|
|
7094
|
+
:param favicon_url: Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
|
|
7095
|
+
:param font_url: Provides the URL where the custom font file is hosted for an Amazon Q web experience.
|
|
7096
|
+
:param logo_url: Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
|
|
6851
7097
|
|
|
6852
7098
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html
|
|
6853
7099
|
:exampleMetadata: fixture=_generated
|
|
@@ -6883,7 +7129,8 @@ class CfnWebExperience(
|
|
|
6883
7129
|
|
|
6884
7130
|
@builtins.property
|
|
6885
7131
|
def custom_css_url(self) -> typing.Optional[builtins.str]:
|
|
6886
|
-
'''
|
|
7132
|
+
'''Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
|
|
7133
|
+
|
|
6887
7134
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-customcssurl
|
|
6888
7135
|
'''
|
|
6889
7136
|
result = self._values.get("custom_css_url")
|
|
@@ -6891,7 +7138,8 @@ class CfnWebExperience(
|
|
|
6891
7138
|
|
|
6892
7139
|
@builtins.property
|
|
6893
7140
|
def favicon_url(self) -> typing.Optional[builtins.str]:
|
|
6894
|
-
'''
|
|
7141
|
+
'''Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
|
|
7142
|
+
|
|
6895
7143
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-faviconurl
|
|
6896
7144
|
'''
|
|
6897
7145
|
result = self._values.get("favicon_url")
|
|
@@ -6899,7 +7147,8 @@ class CfnWebExperience(
|
|
|
6899
7147
|
|
|
6900
7148
|
@builtins.property
|
|
6901
7149
|
def font_url(self) -> typing.Optional[builtins.str]:
|
|
6902
|
-
'''
|
|
7150
|
+
'''Provides the URL where the custom font file is hosted for an Amazon Q web experience.
|
|
7151
|
+
|
|
6903
7152
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-fonturl
|
|
6904
7153
|
'''
|
|
6905
7154
|
result = self._values.get("font_url")
|
|
@@ -6907,7 +7156,8 @@ class CfnWebExperience(
|
|
|
6907
7156
|
|
|
6908
7157
|
@builtins.property
|
|
6909
7158
|
def logo_url(self) -> typing.Optional[builtins.str]:
|
|
6910
|
-
'''
|
|
7159
|
+
'''Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
|
|
7160
|
+
|
|
6911
7161
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-customizationconfiguration.html#cfn-qbusiness-webexperience-customizationconfiguration-logourl
|
|
6912
7162
|
'''
|
|
6913
7163
|
result = self._values.get("logo_url")
|
|
@@ -6941,8 +7191,8 @@ class CfnWebExperience(
|
|
|
6941
7191
|
) -> None:
|
|
6942
7192
|
'''Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
6943
7193
|
|
|
6944
|
-
:param open_id_connect_configuration:
|
|
6945
|
-
:param saml_configuration:
|
|
7194
|
+
:param open_id_connect_configuration: The OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
7195
|
+
:param saml_configuration: The SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
6946
7196
|
|
|
6947
7197
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html
|
|
6948
7198
|
:exampleMetadata: fixture=_generated
|
|
@@ -6977,7 +7227,8 @@ class CfnWebExperience(
|
|
|
6977
7227
|
def open_id_connect_configuration(
|
|
6978
7228
|
self,
|
|
6979
7229
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnWebExperience.OpenIDConnectProviderConfigurationProperty"]]:
|
|
6980
|
-
'''
|
|
7230
|
+
'''The OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
7231
|
+
|
|
6981
7232
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-openidconnectconfiguration
|
|
6982
7233
|
'''
|
|
6983
7234
|
result = self._values.get("open_id_connect_configuration")
|
|
@@ -6987,7 +7238,8 @@ class CfnWebExperience(
|
|
|
6987
7238
|
def saml_configuration(
|
|
6988
7239
|
self,
|
|
6989
7240
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnWebExperience.SamlProviderConfigurationProperty"]]:
|
|
6990
|
-
'''
|
|
7241
|
+
'''The SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
7242
|
+
|
|
6991
7243
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-webexperience-identityproviderconfiguration.html#cfn-qbusiness-webexperience-identityproviderconfiguration-samlconfiguration
|
|
6992
7244
|
'''
|
|
6993
7245
|
result = self._values.get("saml_configuration")
|
|
@@ -7162,7 +7414,7 @@ class CfnWebExperienceProps:
|
|
|
7162
7414
|
'''Properties for defining a ``CfnWebExperience``.
|
|
7163
7415
|
|
|
7164
7416
|
:param application_id: The identifier of the Amazon Q Business web experience.
|
|
7165
|
-
:param customization_configuration:
|
|
7417
|
+
:param customization_configuration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
|
|
7166
7418
|
:param identity_provider_configuration: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
|
|
7167
7419
|
:param origins: Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The *domain origin* refers to the base URL for accessing a website including the protocol ( ``http/https`` ), the domain name, and the port number (if specified). .. epigraph:: You must only submit a *base URL* and not a full path. For example, ``https://docs.aws.amazon.com`` .
|
|
7168
7420
|
:param role_arn: The Amazon Resource Name (ARN) of the service role attached to your web experience. .. epigraph:: You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
|
|
@@ -7260,7 +7512,8 @@ class CfnWebExperienceProps:
|
|
|
7260
7512
|
def customization_configuration(
|
|
7261
7513
|
self,
|
|
7262
7514
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnWebExperience.CustomizationConfigurationProperty]]:
|
|
7263
|
-
'''
|
|
7515
|
+
'''Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
|
|
7516
|
+
|
|
7264
7517
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-webexperience.html#cfn-qbusiness-webexperience-customizationconfiguration
|
|
7265
7518
|
'''
|
|
7266
7519
|
result = self._values.get("customization_configuration")
|
|
@@ -7571,9 +7824,9 @@ def _typecheckingstub__32b7ecf69912e25edcd2354b3e0497931ea6bf042b1aabc881c8677d2
|
|
|
7571
7824
|
id: builtins.str,
|
|
7572
7825
|
*,
|
|
7573
7826
|
action_configurations: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataAccessor.ActionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
7827
|
+
application_id: builtins.str,
|
|
7574
7828
|
display_name: builtins.str,
|
|
7575
7829
|
principal: builtins.str,
|
|
7576
|
-
application_id: typing.Optional[builtins.str] = None,
|
|
7577
7830
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7578
7831
|
) -> None:
|
|
7579
7832
|
"""Type checking stubs"""
|
|
@@ -7597,20 +7850,20 @@ def _typecheckingstub__a27c05d04ed77ea1630a00c4575933bd29a7548e12cd5406b1a703d09
|
|
|
7597
7850
|
"""Type checking stubs"""
|
|
7598
7851
|
pass
|
|
7599
7852
|
|
|
7600
|
-
def
|
|
7853
|
+
def _typecheckingstub__d51b8675a76ff8aa3cd324d2a65da776f4afb1d4600f74839c262998a87adb06(
|
|
7601
7854
|
value: builtins.str,
|
|
7602
7855
|
) -> None:
|
|
7603
7856
|
"""Type checking stubs"""
|
|
7604
7857
|
pass
|
|
7605
7858
|
|
|
7606
|
-
def
|
|
7859
|
+
def _typecheckingstub__d24d4191af1a9b63f7ef66ae53cd5e78c9587db0b3d4e54adc5863415cdec9f0(
|
|
7607
7860
|
value: builtins.str,
|
|
7608
7861
|
) -> None:
|
|
7609
7862
|
"""Type checking stubs"""
|
|
7610
7863
|
pass
|
|
7611
7864
|
|
|
7612
|
-
def
|
|
7613
|
-
value:
|
|
7865
|
+
def _typecheckingstub__fd64ede16f385d2990fa12fa363564c55f359fed279a75365018e42cd6e63fff(
|
|
7866
|
+
value: builtins.str,
|
|
7614
7867
|
) -> None:
|
|
7615
7868
|
"""Type checking stubs"""
|
|
7616
7869
|
pass
|
|
@@ -7673,9 +7926,9 @@ def _typecheckingstub__edee8eec89905fde650437fb2fcf2bc7ddeaecc251be16c2ca1d64d79
|
|
|
7673
7926
|
def _typecheckingstub__4dfde2d4c17793fa3cb9793a9171b9042ac55727b3f0c3a17f1606cab5545458(
|
|
7674
7927
|
*,
|
|
7675
7928
|
action_configurations: typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataAccessor.ActionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]]],
|
|
7929
|
+
application_id: builtins.str,
|
|
7676
7930
|
display_name: builtins.str,
|
|
7677
7931
|
principal: builtins.str,
|
|
7678
|
-
application_id: typing.Optional[builtins.str] = None,
|
|
7679
7932
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7680
7933
|
) -> None:
|
|
7681
7934
|
"""Type checking stubs"""
|
|
@@ -7691,6 +7944,7 @@ def _typecheckingstub__44090f525589bca757ae88a29adc87bbfc36c3149c7964dfd32c2ce59
|
|
|
7691
7944
|
index_id: builtins.str,
|
|
7692
7945
|
description: typing.Optional[builtins.str] = None,
|
|
7693
7946
|
document_enrichment_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.DocumentEnrichmentConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7947
|
+
media_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.MediaExtractionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7694
7948
|
role_arn: typing.Optional[builtins.str] = None,
|
|
7695
7949
|
sync_schedule: typing.Optional[builtins.str] = None,
|
|
7696
7950
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -7747,6 +8001,12 @@ def _typecheckingstub__fe2866ff8510082e320bc29f43593004da60817112846504497bbb0db
|
|
|
7747
8001
|
"""Type checking stubs"""
|
|
7748
8002
|
pass
|
|
7749
8003
|
|
|
8004
|
+
def _typecheckingstub__61d3297e7877958a257749ac6dada8495933c305bc80bd233f5feb0fe4960a81(
|
|
8005
|
+
value: typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDataSource.MediaExtractionConfigurationProperty]],
|
|
8006
|
+
) -> None:
|
|
8007
|
+
"""Type checking stubs"""
|
|
8008
|
+
pass
|
|
8009
|
+
|
|
7750
8010
|
def _typecheckingstub__d17e6c9d50eaaabc9ce2688b35a56e877aaf39df8cd76e73354477d7d5c11a84(
|
|
7751
8011
|
value: typing.Optional[builtins.str],
|
|
7752
8012
|
) -> None:
|
|
@@ -7826,6 +8086,13 @@ def _typecheckingstub__3c33bb8fd2eb803e7000af5893f4f1c6c2062cdbf9cefd30bb8af8419
|
|
|
7826
8086
|
"""Type checking stubs"""
|
|
7827
8087
|
pass
|
|
7828
8088
|
|
|
8089
|
+
def _typecheckingstub__40e7364b05e4957f04891e99e2b4de3fa819ddcc49a154a8118fdf016503e031(
|
|
8090
|
+
*,
|
|
8091
|
+
image_extraction_status: builtins.str,
|
|
8092
|
+
) -> None:
|
|
8093
|
+
"""Type checking stubs"""
|
|
8094
|
+
pass
|
|
8095
|
+
|
|
7829
8096
|
def _typecheckingstub__2025544f51e1e49d0d5dbfb988fb4b22f5cc28a154bdb2e2fe6039f0e941da63(
|
|
7830
8097
|
*,
|
|
7831
8098
|
condition: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.DocumentAttributeConditionProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -7835,6 +8102,13 @@ def _typecheckingstub__2025544f51e1e49d0d5dbfb988fb4b22f5cc28a154bdb2e2fe6039f0e
|
|
|
7835
8102
|
"""Type checking stubs"""
|
|
7836
8103
|
pass
|
|
7837
8104
|
|
|
8105
|
+
def _typecheckingstub__45d49817772a3b69716257ee4a29683841b4420b41115ce7a18bc124fe4f9f87(
|
|
8106
|
+
*,
|
|
8107
|
+
image_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.ImageExtractionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8108
|
+
) -> None:
|
|
8109
|
+
"""Type checking stubs"""
|
|
8110
|
+
pass
|
|
8111
|
+
|
|
7838
8112
|
def _typecheckingstub__b0cb43c018c99c9e24bb29f0d009e1ded318999b690c706f1e2e099d30a9fe07(
|
|
7839
8113
|
*,
|
|
7840
8114
|
application_id: builtins.str,
|
|
@@ -7843,6 +8117,7 @@ def _typecheckingstub__b0cb43c018c99c9e24bb29f0d009e1ded318999b690c706f1e2e099d3
|
|
|
7843
8117
|
index_id: builtins.str,
|
|
7844
8118
|
description: typing.Optional[builtins.str] = None,
|
|
7845
8119
|
document_enrichment_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.DocumentEnrichmentConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8120
|
+
media_extraction_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDataSource.MediaExtractionConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7846
8121
|
role_arn: typing.Optional[builtins.str] = None,
|
|
7847
8122
|
sync_schedule: typing.Optional[builtins.str] = None,
|
|
7848
8123
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|