aws-cdk-lib 2.158.0__py3-none-any.whl → 2.159.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 +36 -19
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.158.0.jsii.tgz → aws-cdk-lib@2.159.1.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +22 -8
- aws_cdk/aws_apigatewayv2/__init__.py +30 -0
- aws_cdk/aws_appconfig/__init__.py +3 -3
- aws_cdk/aws_applicationinsights/__init__.py +544 -4
- aws_cdk/aws_applicationsignals/__init__.py +170 -142
- aws_cdk/aws_athena/__init__.py +15 -15
- aws_cdk/aws_auditmanager/__init__.py +5 -5
- aws_cdk/aws_bedrock/__init__.py +7 -7
- aws_cdk/aws_codebuild/__init__.py +39 -18
- aws_cdk/aws_codeconnections/__init__.py +1 -1
- aws_cdk/aws_cognito/__init__.py +390 -203
- aws_cdk/aws_connect/__init__.py +1679 -152
- aws_cdk/aws_datazone/__init__.py +665 -40
- aws_cdk/aws_docdb/__init__.py +6 -1
- aws_cdk/aws_dynamodb/__init__.py +5 -5
- aws_cdk/aws_ec2/__init__.py +121 -36
- aws_cdk/aws_ecr/__init__.py +14 -6
- aws_cdk/aws_ecs/__init__.py +20 -20
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +167 -20
- aws_cdk/aws_emr/__init__.py +8 -8
- aws_cdk/aws_events/__init__.py +19 -17
- aws_cdk/aws_events_targets/__init__.py +165 -85
- aws_cdk/aws_fms/__init__.py +59 -0
- aws_cdk/aws_fsx/__init__.py +3 -3
- aws_cdk/aws_gamelift/__init__.py +40 -52
- aws_cdk/aws_globalaccelerator/__init__.py +22 -29
- aws_cdk/aws_iam/__init__.py +22 -20
- aws_cdk/aws_iotfleetwise/__init__.py +419 -0
- aws_cdk/aws_iotsitewise/__init__.py +90 -1
- aws_cdk/aws_iotwireless/__init__.py +205 -0
- aws_cdk/aws_lambda/__init__.py +129 -16
- aws_cdk/aws_lex/__init__.py +15 -1
- aws_cdk/aws_logs/__init__.py +1 -1
- aws_cdk/aws_mediaconnect/__init__.py +111 -0
- aws_cdk/aws_medialive/__init__.py +7988 -3262
- aws_cdk/aws_msk/__init__.py +287 -479
- aws_cdk/aws_opensearchservice/__init__.py +6 -0
- aws_cdk/aws_pcaconnectorscep/__init__.py +69 -30
- aws_cdk/aws_pipes/__init__.py +49 -0
- aws_cdk/aws_qbusiness/__init__.py +11 -14
- aws_cdk/aws_quicksight/__init__.py +638 -99
- aws_cdk/aws_rds/__init__.py +38 -27
- aws_cdk/aws_s3/__init__.py +215 -33
- aws_cdk/aws_s3objectlambda/__init__.py +2 -2
- aws_cdk/aws_sagemaker/__init__.py +872 -58
- aws_cdk/aws_secretsmanager/__init__.py +22 -8
- aws_cdk/aws_securityhub/__init__.py +261 -19
- aws_cdk/aws_securitylake/__init__.py +327 -7
- aws_cdk/aws_servicediscovery/__init__.py +5 -5
- aws_cdk/aws_sns/__init__.py +0 -8
- aws_cdk/aws_ssm/__init__.py +20 -12
- aws_cdk/aws_stepfunctions_tasks/__init__.py +36 -0
- aws_cdk/cx_api/__init__.py +19 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/RECORD +62 -62
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.158.0.dist-info → aws_cdk_lib-2.159.1.dist-info}/top_level.txt +0 -0
|
@@ -5555,6 +5555,12 @@ class EngineVersion(
|
|
|
5555
5555
|
'''AWS OpenSearch 2.13.'''
|
|
5556
5556
|
return typing.cast("EngineVersion", jsii.sget(cls, "OPENSEARCH_2_13"))
|
|
5557
5557
|
|
|
5558
|
+
@jsii.python.classproperty
|
|
5559
|
+
@jsii.member(jsii_name="OPENSEARCH_2_15")
|
|
5560
|
+
def OPENSEARCH_2_15(cls) -> "EngineVersion":
|
|
5561
|
+
'''AWS OpenSearch 2.15.'''
|
|
5562
|
+
return typing.cast("EngineVersion", jsii.sget(cls, "OPENSEARCH_2_15"))
|
|
5563
|
+
|
|
5558
5564
|
@jsii.python.classproperty
|
|
5559
5565
|
@jsii.member(jsii_name="OPENSEARCH_2_3")
|
|
5560
5566
|
def OPENSEARCH_2_3(cls) -> "EngineVersion":
|
|
@@ -84,7 +84,11 @@ class CfnChallenge(
|
|
|
84
84
|
metaclass=jsii.JSIIMeta,
|
|
85
85
|
jsii_type="aws-cdk-lib.aws_pcaconnectorscep.CfnChallenge",
|
|
86
86
|
):
|
|
87
|
-
'''
|
|
87
|
+
'''For general-purpose connectors.
|
|
88
|
+
|
|
89
|
+
Creates a *challenge password* for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call `ListConnectors <https://docs.aws.amazon.com/C4SCEP_API/pca-connector-scep/latest/APIReference/API_ListConnectors.html>`_ .
|
|
90
|
+
|
|
91
|
+
To create additional challenge passwords for the connector, call ``CreateChallenge`` again. We recommend frequently rotating your challenge passwords.
|
|
88
92
|
|
|
89
93
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html
|
|
90
94
|
:cloudformationResource: AWS::PCAConnectorSCEP::Challenge
|
|
@@ -117,7 +121,7 @@ class CfnChallenge(
|
|
|
117
121
|
'''
|
|
118
122
|
:param scope: Scope in which this resource is defined.
|
|
119
123
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
120
|
-
:param connector_arn:
|
|
124
|
+
:param connector_arn: The Amazon Resource Name (ARN) of the connector.
|
|
121
125
|
:param tags:
|
|
122
126
|
'''
|
|
123
127
|
if __debug__:
|
|
@@ -161,7 +165,8 @@ class CfnChallenge(
|
|
|
161
165
|
@builtins.property
|
|
162
166
|
@jsii.member(jsii_name="attrChallengeArn")
|
|
163
167
|
def attr_challenge_arn(self) -> builtins.str:
|
|
164
|
-
'''
|
|
168
|
+
'''The Amazon Resource Name (ARN) of the challenge.
|
|
169
|
+
|
|
165
170
|
:cloudformationAttribute: ChallengeArn
|
|
166
171
|
'''
|
|
167
172
|
return typing.cast(builtins.str, jsii.get(self, "attrChallengeArn"))
|
|
@@ -180,6 +185,7 @@ class CfnChallenge(
|
|
|
180
185
|
@builtins.property
|
|
181
186
|
@jsii.member(jsii_name="connectorArn")
|
|
182
187
|
def connector_arn(self) -> builtins.str:
|
|
188
|
+
'''The Amazon Resource Name (ARN) of the connector.'''
|
|
183
189
|
return typing.cast(builtins.str, jsii.get(self, "connectorArn"))
|
|
184
190
|
|
|
185
191
|
@connector_arn.setter
|
|
@@ -219,7 +225,7 @@ class CfnChallengeProps:
|
|
|
219
225
|
) -> None:
|
|
220
226
|
'''Properties for defining a ``CfnChallenge``.
|
|
221
227
|
|
|
222
|
-
:param connector_arn:
|
|
228
|
+
:param connector_arn: The Amazon Resource Name (ARN) of the connector.
|
|
223
229
|
:param tags:
|
|
224
230
|
|
|
225
231
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html
|
|
@@ -252,7 +258,8 @@ class CfnChallengeProps:
|
|
|
252
258
|
|
|
253
259
|
@builtins.property
|
|
254
260
|
def connector_arn(self) -> builtins.str:
|
|
255
|
-
'''
|
|
261
|
+
'''The Amazon Resource Name (ARN) of the connector.
|
|
262
|
+
|
|
256
263
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#cfn-pcaconnectorscep-challenge-connectorarn
|
|
257
264
|
'''
|
|
258
265
|
result = self._values.get("connector_arn")
|
|
@@ -285,7 +292,9 @@ class CfnConnector(
|
|
|
285
292
|
metaclass=jsii.JSIIMeta,
|
|
286
293
|
jsii_type="aws-cdk-lib.aws_pcaconnectorscep.CfnConnector",
|
|
287
294
|
):
|
|
288
|
-
'''
|
|
295
|
+
'''Connector for SCEP is a service that links AWS Private Certificate Authority to your SCEP-enabled devices.
|
|
296
|
+
|
|
297
|
+
The connector brokers the exchange of certificates from AWS Private CA to your SCEP-enabled devices and mobile device management systems. The connector is a complex type that contains the connector's configuration settings.
|
|
289
298
|
|
|
290
299
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html
|
|
291
300
|
:cloudformationResource: AWS::PCAConnectorSCEP::Connector
|
|
@@ -325,8 +334,8 @@ class CfnConnector(
|
|
|
325
334
|
'''
|
|
326
335
|
:param scope: Scope in which this resource is defined.
|
|
327
336
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
328
|
-
:param certificate_authority_arn:
|
|
329
|
-
:param mobile_device_management:
|
|
337
|
+
:param certificate_authority_arn: The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
|
|
338
|
+
:param mobile_device_management: Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure ``MobileDeviceManagement`` , then the connector is for general-purpose use and this object is empty.
|
|
330
339
|
:param tags:
|
|
331
340
|
'''
|
|
332
341
|
if __debug__:
|
|
@@ -374,7 +383,8 @@ class CfnConnector(
|
|
|
374
383
|
@builtins.property
|
|
375
384
|
@jsii.member(jsii_name="attrConnectorArn")
|
|
376
385
|
def attr_connector_arn(self) -> builtins.str:
|
|
377
|
-
'''
|
|
386
|
+
'''The Amazon Resource Name (ARN) of the connector.
|
|
387
|
+
|
|
378
388
|
:cloudformationAttribute: ConnectorArn
|
|
379
389
|
'''
|
|
380
390
|
return typing.cast(builtins.str, jsii.get(self, "attrConnectorArn"))
|
|
@@ -382,7 +392,8 @@ class CfnConnector(
|
|
|
382
392
|
@builtins.property
|
|
383
393
|
@jsii.member(jsii_name="attrEndpoint")
|
|
384
394
|
def attr_endpoint(self) -> builtins.str:
|
|
385
|
-
'''
|
|
395
|
+
'''The connector's HTTPS public SCEP URL.
|
|
396
|
+
|
|
386
397
|
:cloudformationAttribute: Endpoint
|
|
387
398
|
'''
|
|
388
399
|
return typing.cast(builtins.str, jsii.get(self, "attrEndpoint"))
|
|
@@ -398,7 +409,8 @@ class CfnConnector(
|
|
|
398
409
|
@builtins.property
|
|
399
410
|
@jsii.member(jsii_name="attrType")
|
|
400
411
|
def attr_type(self) -> builtins.str:
|
|
401
|
-
'''
|
|
412
|
+
'''The connector type.
|
|
413
|
+
|
|
402
414
|
:cloudformationAttribute: Type
|
|
403
415
|
'''
|
|
404
416
|
return typing.cast(builtins.str, jsii.get(self, "attrType"))
|
|
@@ -417,6 +429,7 @@ class CfnConnector(
|
|
|
417
429
|
@builtins.property
|
|
418
430
|
@jsii.member(jsii_name="certificateAuthorityArn")
|
|
419
431
|
def certificate_authority_arn(self) -> builtins.str:
|
|
432
|
+
'''The Amazon Resource Name (ARN) of the certificate authority associated with the connector.'''
|
|
420
433
|
return typing.cast(builtins.str, jsii.get(self, "certificateAuthorityArn"))
|
|
421
434
|
|
|
422
435
|
@certificate_authority_arn.setter
|
|
@@ -431,6 +444,7 @@ class CfnConnector(
|
|
|
431
444
|
def mobile_device_management(
|
|
432
445
|
self,
|
|
433
446
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConnector.MobileDeviceManagementProperty"]]:
|
|
447
|
+
'''Contains settings relevant to the mobile device management system that you chose for the connector.'''
|
|
434
448
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConnector.MobileDeviceManagementProperty"]], jsii.get(self, "mobileDeviceManagement"))
|
|
435
449
|
|
|
436
450
|
@mobile_device_management.setter
|
|
@@ -473,9 +487,14 @@ class CfnConnector(
|
|
|
473
487
|
azure_application_id: builtins.str,
|
|
474
488
|
domain: builtins.str,
|
|
475
489
|
) -> None:
|
|
476
|
-
'''
|
|
477
|
-
|
|
478
|
-
|
|
490
|
+
'''Contains configuration details for use with Microsoft Intune.
|
|
491
|
+
|
|
492
|
+
For information about using Connector for SCEP for Microsoft Intune, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`_ .
|
|
493
|
+
|
|
494
|
+
When you use Connector for SCEP for Microsoft Intune, certain functionalities are enabled by accessing Microsoft Intune through the Microsoft API. Your use of the Connector for SCEP and accompanying AWS services doesn't remove your need to have a valid license for your use of the Microsoft Intune service. You should also review the `Microsoft Intune® App Protection Policies <https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/mem/intune/apps/app-protection-policy>`_ .
|
|
495
|
+
|
|
496
|
+
:param azure_application_id: The directory (tenant) ID from your Microsoft Entra ID app registration.
|
|
497
|
+
:param domain: The primary domain from your Microsoft Entra ID app registration.
|
|
479
498
|
|
|
480
499
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html
|
|
481
500
|
:exampleMetadata: fixture=_generated
|
|
@@ -502,7 +521,8 @@ class CfnConnector(
|
|
|
502
521
|
|
|
503
522
|
@builtins.property
|
|
504
523
|
def azure_application_id(self) -> builtins.str:
|
|
505
|
-
'''
|
|
524
|
+
'''The directory (tenant) ID from your Microsoft Entra ID app registration.
|
|
525
|
+
|
|
506
526
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-azureapplicationid
|
|
507
527
|
'''
|
|
508
528
|
result = self._values.get("azure_application_id")
|
|
@@ -511,7 +531,8 @@ class CfnConnector(
|
|
|
511
531
|
|
|
512
532
|
@builtins.property
|
|
513
533
|
def domain(self) -> builtins.str:
|
|
514
|
-
'''
|
|
534
|
+
'''The primary domain from your Microsoft Entra ID app registration.
|
|
535
|
+
|
|
515
536
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-domain
|
|
516
537
|
'''
|
|
517
538
|
result = self._values.get("domain")
|
|
@@ -540,8 +561,13 @@ class CfnConnector(
|
|
|
540
561
|
*,
|
|
541
562
|
intune: typing.Union[_IResolvable_da3f097b, typing.Union["CfnConnector.IntuneConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
|
|
542
563
|
) -> None:
|
|
543
|
-
'''
|
|
544
|
-
|
|
564
|
+
'''If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use.
|
|
565
|
+
|
|
566
|
+
A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see `Considerations and Limitations <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html>`_ .
|
|
567
|
+
|
|
568
|
+
If you provide an ``IntuneConfiguration`` , Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`_ .
|
|
569
|
+
|
|
570
|
+
:param intune: Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`_ .
|
|
545
571
|
|
|
546
572
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html
|
|
547
573
|
:exampleMetadata: fixture=_generated
|
|
@@ -570,7 +596,10 @@ class CfnConnector(
|
|
|
570
596
|
def intune(
|
|
571
597
|
self,
|
|
572
598
|
) -> typing.Union[_IResolvable_da3f097b, "CfnConnector.IntuneConfigurationProperty"]:
|
|
573
|
-
'''
|
|
599
|
+
'''Configuration settings for use with Microsoft Intune.
|
|
600
|
+
|
|
601
|
+
For information about using Connector for SCEP for Microsoft Intune, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`_ .
|
|
602
|
+
|
|
574
603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement-intune
|
|
575
604
|
'''
|
|
576
605
|
result = self._values.get("intune")
|
|
@@ -605,10 +634,13 @@ class CfnConnector(
|
|
|
605
634
|
issuer: typing.Optional[builtins.str] = None,
|
|
606
635
|
subject: typing.Optional[builtins.str] = None,
|
|
607
636
|
) -> None:
|
|
608
|
-
'''
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
637
|
+
'''Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune.
|
|
638
|
+
|
|
639
|
+
For more information about using Connector for SCEP for Microsoft Intune, see `Using Connector for SCEP for Microsoft Intune <https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html>`_ .
|
|
640
|
+
|
|
641
|
+
:param audience: The audience value to copy into your Microsoft Entra app registration's OIDC.
|
|
642
|
+
:param issuer: The issuer value to copy into your Microsoft Entra app registration's OIDC.
|
|
643
|
+
:param subject: The subject value to copy into your Microsoft Entra app registration's OIDC.
|
|
612
644
|
|
|
613
645
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html
|
|
614
646
|
:exampleMetadata: fixture=_generated
|
|
@@ -640,7 +672,8 @@ class CfnConnector(
|
|
|
640
672
|
|
|
641
673
|
@builtins.property
|
|
642
674
|
def audience(self) -> typing.Optional[builtins.str]:
|
|
643
|
-
'''
|
|
675
|
+
'''The audience value to copy into your Microsoft Entra app registration's OIDC.
|
|
676
|
+
|
|
644
677
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-audience
|
|
645
678
|
'''
|
|
646
679
|
result = self._values.get("audience")
|
|
@@ -648,7 +681,8 @@ class CfnConnector(
|
|
|
648
681
|
|
|
649
682
|
@builtins.property
|
|
650
683
|
def issuer(self) -> typing.Optional[builtins.str]:
|
|
651
|
-
'''
|
|
684
|
+
'''The issuer value to copy into your Microsoft Entra app registration's OIDC.
|
|
685
|
+
|
|
652
686
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-issuer
|
|
653
687
|
'''
|
|
654
688
|
result = self._values.get("issuer")
|
|
@@ -656,7 +690,8 @@ class CfnConnector(
|
|
|
656
690
|
|
|
657
691
|
@builtins.property
|
|
658
692
|
def subject(self) -> typing.Optional[builtins.str]:
|
|
659
|
-
'''
|
|
693
|
+
'''The subject value to copy into your Microsoft Entra app registration's OIDC.
|
|
694
|
+
|
|
660
695
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-subject
|
|
661
696
|
'''
|
|
662
697
|
result = self._values.get("subject")
|
|
@@ -693,8 +728,8 @@ class CfnConnectorProps:
|
|
|
693
728
|
) -> None:
|
|
694
729
|
'''Properties for defining a ``CfnConnector``.
|
|
695
730
|
|
|
696
|
-
:param certificate_authority_arn:
|
|
697
|
-
:param mobile_device_management:
|
|
731
|
+
:param certificate_authority_arn: The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
|
|
732
|
+
:param mobile_device_management: Contains settings relevant to the mobile device management system that you chose for the connector. If you didn't configure ``MobileDeviceManagement`` , then the connector is for general-purpose use and this object is empty.
|
|
698
733
|
:param tags:
|
|
699
734
|
|
|
700
735
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html
|
|
@@ -736,7 +771,8 @@ class CfnConnectorProps:
|
|
|
736
771
|
|
|
737
772
|
@builtins.property
|
|
738
773
|
def certificate_authority_arn(self) -> builtins.str:
|
|
739
|
-
'''
|
|
774
|
+
'''The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
|
|
775
|
+
|
|
740
776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-certificateauthorityarn
|
|
741
777
|
'''
|
|
742
778
|
result = self._values.get("certificate_authority_arn")
|
|
@@ -747,7 +783,10 @@ class CfnConnectorProps:
|
|
|
747
783
|
def mobile_device_management(
|
|
748
784
|
self,
|
|
749
785
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnConnector.MobileDeviceManagementProperty]]:
|
|
750
|
-
'''
|
|
786
|
+
'''Contains settings relevant to the mobile device management system that you chose for the connector.
|
|
787
|
+
|
|
788
|
+
If you didn't configure ``MobileDeviceManagement`` , then the connector is for general-purpose use and this object is empty.
|
|
789
|
+
|
|
751
790
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement
|
|
752
791
|
'''
|
|
753
792
|
result = self._values.get("mobile_device_management")
|
aws_cdk/aws_pipes/__init__.py
CHANGED
|
@@ -113,6 +113,7 @@ class CfnPipe(
|
|
|
113
113
|
),
|
|
114
114
|
input_template="inputTemplate"
|
|
115
115
|
),
|
|
116
|
+
kms_key_identifier="kmsKeyIdentifier",
|
|
116
117
|
log_configuration=pipes.CfnPipe.PipeLogConfigurationProperty(
|
|
117
118
|
cloudwatch_logs_log_destination=pipes.CfnPipe.CloudwatchLogsLogDestinationProperty(
|
|
118
119
|
log_group_arn="logGroupArn"
|
|
@@ -426,6 +427,7 @@ class CfnPipe(
|
|
|
426
427
|
desired_state: typing.Optional[builtins.str] = None,
|
|
427
428
|
enrichment: typing.Optional[builtins.str] = None,
|
|
428
429
|
enrichment_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPipe.PipeEnrichmentParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
430
|
+
kms_key_identifier: typing.Optional[builtins.str] = None,
|
|
429
431
|
log_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPipe.PipeLogConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
430
432
|
name: typing.Optional[builtins.str] = None,
|
|
431
433
|
source_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnPipe.PipeSourceParametersProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -442,6 +444,7 @@ class CfnPipe(
|
|
|
442
444
|
:param desired_state: The state the pipe should be in.
|
|
443
445
|
:param enrichment: The ARN of the enrichment resource.
|
|
444
446
|
:param enrichment_parameters: The parameters required to set up enrichment on your pipe.
|
|
447
|
+
:param kms_key_identifier: The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string. For more information, see `Managing keys <https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html>`_ in the *AWS Key Management Service Developer Guide* .
|
|
445
448
|
:param log_configuration: The logging configuration settings for the pipe.
|
|
446
449
|
:param name: The name of the pipe.
|
|
447
450
|
:param source_parameters: The parameters required to set up a source for your pipe.
|
|
@@ -460,6 +463,7 @@ class CfnPipe(
|
|
|
460
463
|
desired_state=desired_state,
|
|
461
464
|
enrichment=enrichment,
|
|
462
465
|
enrichment_parameters=enrichment_parameters,
|
|
466
|
+
kms_key_identifier=kms_key_identifier,
|
|
463
467
|
log_configuration=log_configuration,
|
|
464
468
|
name=name,
|
|
465
469
|
source_parameters=source_parameters,
|
|
@@ -651,6 +655,19 @@ class CfnPipe(
|
|
|
651
655
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
652
656
|
jsii.set(self, "enrichmentParameters", value) # pyright: ignore[reportArgumentType]
|
|
653
657
|
|
|
658
|
+
@builtins.property
|
|
659
|
+
@jsii.member(jsii_name="kmsKeyIdentifier")
|
|
660
|
+
def kms_key_identifier(self) -> typing.Optional[builtins.str]:
|
|
661
|
+
'''The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.'''
|
|
662
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kmsKeyIdentifier"))
|
|
663
|
+
|
|
664
|
+
@kms_key_identifier.setter
|
|
665
|
+
def kms_key_identifier(self, value: typing.Optional[builtins.str]) -> None:
|
|
666
|
+
if __debug__:
|
|
667
|
+
type_hints = typing.get_type_hints(_typecheckingstub__1052edd5ce80236ce4a971335ad896a6630839b27758cef9a2858368e2da759b)
|
|
668
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
669
|
+
jsii.set(self, "kmsKeyIdentifier", value) # pyright: ignore[reportArgumentType]
|
|
670
|
+
|
|
654
671
|
@builtins.property
|
|
655
672
|
@jsii.member(jsii_name="logConfiguration")
|
|
656
673
|
def log_configuration(
|
|
@@ -7027,6 +7044,7 @@ class CfnPipe(
|
|
|
7027
7044
|
"desired_state": "desiredState",
|
|
7028
7045
|
"enrichment": "enrichment",
|
|
7029
7046
|
"enrichment_parameters": "enrichmentParameters",
|
|
7047
|
+
"kms_key_identifier": "kmsKeyIdentifier",
|
|
7030
7048
|
"log_configuration": "logConfiguration",
|
|
7031
7049
|
"name": "name",
|
|
7032
7050
|
"source_parameters": "sourceParameters",
|
|
@@ -7045,6 +7063,7 @@ class CfnPipeProps:
|
|
|
7045
7063
|
desired_state: typing.Optional[builtins.str] = None,
|
|
7046
7064
|
enrichment: typing.Optional[builtins.str] = None,
|
|
7047
7065
|
enrichment_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeEnrichmentParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7066
|
+
kms_key_identifier: typing.Optional[builtins.str] = None,
|
|
7048
7067
|
log_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeLogConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7049
7068
|
name: typing.Optional[builtins.str] = None,
|
|
7050
7069
|
source_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeSourceParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -7060,6 +7079,7 @@ class CfnPipeProps:
|
|
|
7060
7079
|
:param desired_state: The state the pipe should be in.
|
|
7061
7080
|
:param enrichment: The ARN of the enrichment resource.
|
|
7062
7081
|
:param enrichment_parameters: The parameters required to set up enrichment on your pipe.
|
|
7082
|
+
:param kms_key_identifier: The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string. For more information, see `Managing keys <https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html>`_ in the *AWS Key Management Service Developer Guide* .
|
|
7063
7083
|
:param log_configuration: The logging configuration settings for the pipe.
|
|
7064
7084
|
:param name: The name of the pipe.
|
|
7065
7085
|
:param source_parameters: The parameters required to set up a source for your pipe.
|
|
@@ -7096,6 +7116,7 @@ class CfnPipeProps:
|
|
|
7096
7116
|
),
|
|
7097
7117
|
input_template="inputTemplate"
|
|
7098
7118
|
),
|
|
7119
|
+
kms_key_identifier="kmsKeyIdentifier",
|
|
7099
7120
|
log_configuration=pipes.CfnPipe.PipeLogConfigurationProperty(
|
|
7100
7121
|
cloudwatch_logs_log_destination=pipes.CfnPipe.CloudwatchLogsLogDestinationProperty(
|
|
7101
7122
|
log_group_arn="logGroupArn"
|
|
@@ -7405,6 +7426,7 @@ class CfnPipeProps:
|
|
|
7405
7426
|
check_type(argname="argument desired_state", value=desired_state, expected_type=type_hints["desired_state"])
|
|
7406
7427
|
check_type(argname="argument enrichment", value=enrichment, expected_type=type_hints["enrichment"])
|
|
7407
7428
|
check_type(argname="argument enrichment_parameters", value=enrichment_parameters, expected_type=type_hints["enrichment_parameters"])
|
|
7429
|
+
check_type(argname="argument kms_key_identifier", value=kms_key_identifier, expected_type=type_hints["kms_key_identifier"])
|
|
7408
7430
|
check_type(argname="argument log_configuration", value=log_configuration, expected_type=type_hints["log_configuration"])
|
|
7409
7431
|
check_type(argname="argument name", value=name, expected_type=type_hints["name"])
|
|
7410
7432
|
check_type(argname="argument source_parameters", value=source_parameters, expected_type=type_hints["source_parameters"])
|
|
@@ -7423,6 +7445,8 @@ class CfnPipeProps:
|
|
|
7423
7445
|
self._values["enrichment"] = enrichment
|
|
7424
7446
|
if enrichment_parameters is not None:
|
|
7425
7447
|
self._values["enrichment_parameters"] = enrichment_parameters
|
|
7448
|
+
if kms_key_identifier is not None:
|
|
7449
|
+
self._values["kms_key_identifier"] = kms_key_identifier
|
|
7426
7450
|
if log_configuration is not None:
|
|
7427
7451
|
self._values["log_configuration"] = log_configuration
|
|
7428
7452
|
if name is not None:
|
|
@@ -7502,6 +7526,23 @@ class CfnPipeProps:
|
|
|
7502
7526
|
result = self._values.get("enrichment_parameters")
|
|
7503
7527
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, CfnPipe.PipeEnrichmentParametersProperty]], result)
|
|
7504
7528
|
|
|
7529
|
+
@builtins.property
|
|
7530
|
+
def kms_key_identifier(self) -> typing.Optional[builtins.str]:
|
|
7531
|
+
'''The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
|
|
7532
|
+
|
|
7533
|
+
The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
|
|
7534
|
+
|
|
7535
|
+
To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.
|
|
7536
|
+
|
|
7537
|
+
To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.
|
|
7538
|
+
|
|
7539
|
+
For more information, see `Managing keys <https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html>`_ in the *AWS Key Management Service Developer Guide* .
|
|
7540
|
+
|
|
7541
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-kmskeyidentifier
|
|
7542
|
+
'''
|
|
7543
|
+
result = self._values.get("kms_key_identifier")
|
|
7544
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
7545
|
+
|
|
7505
7546
|
@builtins.property
|
|
7506
7547
|
def log_configuration(
|
|
7507
7548
|
self,
|
|
@@ -7585,6 +7626,7 @@ def _typecheckingstub__2590746a77e697feb25a71ec367eb957a7632f9fe5a46ae7e30476068
|
|
|
7585
7626
|
desired_state: typing.Optional[builtins.str] = None,
|
|
7586
7627
|
enrichment: typing.Optional[builtins.str] = None,
|
|
7587
7628
|
enrichment_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeEnrichmentParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7629
|
+
kms_key_identifier: typing.Optional[builtins.str] = None,
|
|
7588
7630
|
log_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeLogConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7589
7631
|
name: typing.Optional[builtins.str] = None,
|
|
7590
7632
|
source_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeSourceParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -7648,6 +7690,12 @@ def _typecheckingstub__75aa67d8831c93b78f85f7319ad758289b207fec83baf9b92034cab44
|
|
|
7648
7690
|
"""Type checking stubs"""
|
|
7649
7691
|
pass
|
|
7650
7692
|
|
|
7693
|
+
def _typecheckingstub__1052edd5ce80236ce4a971335ad896a6630839b27758cef9a2858368e2da759b(
|
|
7694
|
+
value: typing.Optional[builtins.str],
|
|
7695
|
+
) -> None:
|
|
7696
|
+
"""Type checking stubs"""
|
|
7697
|
+
pass
|
|
7698
|
+
|
|
7651
7699
|
def _typecheckingstub__3975e792335934f36dcb66bc10ba0ab93afe079dae88c2011a2bacc35a8fe756(
|
|
7652
7700
|
value: typing.Optional[typing.Union[_IResolvable_da3f097b, CfnPipe.PipeLogConfigurationProperty]],
|
|
7653
7701
|
) -> None:
|
|
@@ -8233,6 +8281,7 @@ def _typecheckingstub__f6a6720db1bd2e7acc178f6bd481fd8e3e740405a24c01b669c4c4595
|
|
|
8233
8281
|
desired_state: typing.Optional[builtins.str] = None,
|
|
8234
8282
|
enrichment: typing.Optional[builtins.str] = None,
|
|
8235
8283
|
enrichment_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeEnrichmentParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8284
|
+
kms_key_identifier: typing.Optional[builtins.str] = None,
|
|
8236
8285
|
log_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeLogConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8237
8286
|
name: typing.Optional[builtins.str] = None,
|
|
8238
8287
|
source_parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnPipe.PipeSourceParametersProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
@@ -169,7 +169,7 @@ class CfnApplication(
|
|
|
169
169
|
:param identity_type: The authentication type being used by a Amazon Q Business application.
|
|
170
170
|
: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>`_ .
|
|
171
171
|
:param q_apps_configuration: Configuration information about Amazon Q Apps.
|
|
172
|
-
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
|
|
172
|
+
: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.
|
|
173
173
|
: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: _ . : / = + -
|
|
174
174
|
'''
|
|
175
175
|
if __debug__:
|
|
@@ -832,7 +832,7 @@ class CfnApplicationProps:
|
|
|
832
832
|
:param identity_type: The authentication type being used by a Amazon Q Business application.
|
|
833
833
|
: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>`_ .
|
|
834
834
|
:param q_apps_configuration: Configuration information about Amazon Q Apps.
|
|
835
|
-
:param role_arn: The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
|
|
835
|
+
: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.
|
|
836
836
|
: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: _ . : / = + -
|
|
837
837
|
|
|
838
838
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
|
|
@@ -1040,6 +1040,8 @@ class CfnApplicationProps:
|
|
|
1040
1040
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
1041
1041
|
'''The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
|
|
1042
1042
|
|
|
1043
|
+
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.
|
|
1044
|
+
|
|
1043
1045
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-rolearn
|
|
1044
1046
|
'''
|
|
1045
1047
|
result = self._values.get("role_arn")
|
|
@@ -1195,7 +1197,7 @@ class CfnDataSource(
|
|
|
1195
1197
|
:param scope: Scope in which this resource is defined.
|
|
1196
1198
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1197
1199
|
:param application_id: The identifier of the Amazon Q Business application the data source will be attached to.
|
|
1198
|
-
:param configuration:
|
|
1200
|
+
:param configuration: Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . You can find configuration templates for your specific data source using the following steps: - Navigate to the `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ page in the Amazon Q Business User Guide, and select the data source connector of your choice. - Then, from that specific data source connector's page, select *Using AWS CloudFormation* to find the schemas for your data source connector, including parameter descriptions and examples.
|
|
1199
1201
|
:param display_name: The name of the Amazon Q Business data source.
|
|
1200
1202
|
:param index_id: The identifier of the index the data source is attached to.
|
|
1201
1203
|
:param description: A description for the data source connector.
|
|
@@ -1335,7 +1337,7 @@ class CfnDataSource(
|
|
|
1335
1337
|
@builtins.property
|
|
1336
1338
|
@jsii.member(jsii_name="configuration")
|
|
1337
1339
|
def configuration(self) -> typing.Any:
|
|
1338
|
-
'''
|
|
1340
|
+
'''Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business .'''
|
|
1339
1341
|
return typing.cast(typing.Any, jsii.get(self, "configuration"))
|
|
1340
1342
|
|
|
1341
1343
|
@configuration.setter
|
|
@@ -2315,7 +2317,7 @@ class CfnDataSourceProps:
|
|
|
2315
2317
|
'''Properties for defining a ``CfnDataSource``.
|
|
2316
2318
|
|
|
2317
2319
|
:param application_id: The identifier of the Amazon Q Business application the data source will be attached to.
|
|
2318
|
-
:param configuration:
|
|
2320
|
+
:param configuration: Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . You can find configuration templates for your specific data source using the following steps: - Navigate to the `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ page in the Amazon Q Business User Guide, and select the data source connector of your choice. - Then, from that specific data source connector's page, select *Using AWS CloudFormation* to find the schemas for your data source connector, including parameter descriptions and examples.
|
|
2319
2321
|
:param display_name: The name of the Amazon Q Business data source.
|
|
2320
2322
|
:param index_id: The identifier of the index the data source is attached to.
|
|
2321
2323
|
:param description: A description for the data source connector.
|
|
@@ -2462,19 +2464,14 @@ class CfnDataSourceProps:
|
|
|
2462
2464
|
|
|
2463
2465
|
@builtins.property
|
|
2464
2466
|
def configuration(self) -> typing.Any:
|
|
2465
|
-
'''
|
|
2466
|
-
|
|
2467
|
-
Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
|
|
2468
|
-
|
|
2469
|
-
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
|
|
2467
|
+
'''Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business .
|
|
2470
2468
|
|
|
2471
|
-
|
|
2472
|
-
- `Web Crawler JSON schema <https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/web-crawler-api.html>`_
|
|
2469
|
+
You must use the JSON or YAML schema provided by Amazon Q .
|
|
2473
2470
|
|
|
2474
2471
|
You can find configuration templates for your specific data source using the following steps:
|
|
2475
2472
|
|
|
2476
|
-
- Navigate to the `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ page in the Amazon Q Business User Guide, and select the data source of your choice.
|
|
2477
|
-
- Then, from
|
|
2473
|
+
- Navigate to the `Supported connectors <https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html>`_ page in the Amazon Q Business User Guide, and select the data source connector of your choice.
|
|
2474
|
+
- Then, from that specific data source connector's page, select *Using AWS CloudFormation* to find the schemas for your data source connector, including parameter descriptions and examples.
|
|
2478
2475
|
|
|
2479
2476
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html#cfn-qbusiness-datasource-configuration
|
|
2480
2477
|
'''
|