aws-cdk-lib 2.73.0__py3-none-any.whl → 2.76.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

Files changed (111) hide show
  1. aws_cdk/__init__.py +245 -259
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.73.0.jsii.tgz → aws-cdk-lib@2.76.0.jsii.tgz} +0 -0
  4. aws_cdk/aws_amplifyuibuilder/__init__.py +182 -214
  5. aws_cdk/aws_apigateway/__init__.py +95 -148
  6. aws_cdk/aws_appconfig/__init__.py +8 -4
  7. aws_cdk/aws_appflow/__init__.py +27 -52
  8. aws_cdk/aws_appmesh/__init__.py +91 -200
  9. aws_cdk/aws_apprunner/__init__.py +4 -16
  10. aws_cdk/aws_appstream/__init__.py +18 -82
  11. aws_cdk/aws_athena/__init__.py +18 -32
  12. aws_cdk/aws_backup/__init__.py +48 -86
  13. aws_cdk/aws_batch/__init__.py +9 -2
  14. aws_cdk/aws_billingconductor/__init__.py +12 -7
  15. aws_cdk/aws_budgets/__init__.py +8 -17
  16. aws_cdk/aws_certificatemanager/__init__.py +7 -4
  17. aws_cdk/aws_cloudfront/__init__.py +14 -11
  18. aws_cdk/aws_cloudfront_origins/__init__.py +18 -8
  19. aws_cdk/aws_cloudtrail/__init__.py +7 -14
  20. aws_cdk/aws_cloudwatch/__init__.py +63 -35
  21. aws_cdk/aws_codebuild/__init__.py +10 -13
  22. aws_cdk/aws_codecommit/__init__.py +0 -1
  23. aws_cdk/aws_codedeploy/__init__.py +165 -162
  24. aws_cdk/aws_codegurureviewer/__init__.py +4 -4
  25. aws_cdk/aws_codepipeline/__init__.py +0 -4
  26. aws_cdk/aws_codepipeline_actions/__init__.py +16 -164
  27. aws_cdk/aws_cognito/__init__.py +195 -100
  28. aws_cdk/aws_config/__init__.py +28 -51
  29. aws_cdk/aws_connectcampaigns/__init__.py +5 -6
  30. aws_cdk/aws_databrew/__init__.py +5 -6
  31. aws_cdk/aws_dlm/__init__.py +33 -71
  32. aws_cdk/aws_docdb/__init__.py +20 -76
  33. aws_cdk/aws_dynamodb/__init__.py +29 -22
  34. aws_cdk/aws_ec2/__init__.py +2414 -603
  35. aws_cdk/aws_ecr/__init__.py +1 -2
  36. aws_cdk/aws_ecr_assets/__init__.py +27 -14
  37. aws_cdk/aws_ecs/__init__.py +458 -163
  38. aws_cdk/aws_ecs_patterns/__init__.py +13 -11
  39. aws_cdk/aws_eks/__init__.py +13 -8
  40. aws_cdk/aws_elasticloadbalancing/__init__.py +16 -9
  41. aws_cdk/aws_elasticloadbalancingv2/__init__.py +142 -82
  42. aws_cdk/aws_elasticloadbalancingv2_actions/__init__.py +126 -61
  43. aws_cdk/aws_elasticsearch/__init__.py +0 -7
  44. aws_cdk/aws_emr/__init__.py +7 -16
  45. aws_cdk/aws_emrserverless/__init__.py +14 -18
  46. aws_cdk/aws_events/__init__.py +33 -29
  47. aws_cdk/aws_events_targets/__init__.py +248 -89
  48. aws_cdk/aws_frauddetector/__init__.py +3 -4
  49. aws_cdk/aws_fsx/__init__.py +13 -7
  50. aws_cdk/aws_gamelift/__init__.py +11 -20
  51. aws_cdk/aws_grafana/__init__.py +4 -4
  52. aws_cdk/aws_iam/__init__.py +21 -25
  53. aws_cdk/aws_imagebuilder/__init__.py +58 -80
  54. aws_cdk/aws_internetmonitor/__init__.py +18 -10
  55. aws_cdk/aws_iot/__init__.py +16 -10
  56. aws_cdk/aws_iotcoredeviceadvisor/__init__.py +16 -26
  57. aws_cdk/aws_iotevents/__init__.py +6 -4
  58. aws_cdk/aws_iotfleetwise/__init__.py +27 -40
  59. aws_cdk/aws_iotsitewise/__init__.py +8 -5
  60. aws_cdk/aws_iotwireless/__init__.py +14 -9
  61. aws_cdk/aws_kinesisfirehose/__init__.py +21 -38
  62. aws_cdk/aws_lambda/__init__.py +76 -53
  63. aws_cdk/aws_lambda_event_sources/__init__.py +6 -21
  64. aws_cdk/aws_logs/__init__.py +5 -7
  65. aws_cdk/aws_macie/__init__.py +28 -23
  66. aws_cdk/aws_mediaconnect/__init__.py +5 -8
  67. aws_cdk/aws_mediaconvert/__init__.py +2 -2
  68. aws_cdk/aws_medialive/__init__.py +2 -4
  69. aws_cdk/aws_mediapackage/__init__.py +9 -18
  70. aws_cdk/aws_memorydb/__init__.py +5 -10
  71. aws_cdk/aws_mwaa/__init__.py +8 -4
  72. aws_cdk/aws_neptune/__init__.py +4 -4
  73. aws_cdk/aws_networkfirewall/__init__.py +8 -4
  74. aws_cdk/aws_networkmanager/__init__.py +4 -4
  75. aws_cdk/aws_nimblestudio/__init__.py +25 -45
  76. aws_cdk/aws_opensearchservice/__init__.py +0 -1
  77. aws_cdk/aws_panorama/__init__.py +11 -12
  78. aws_cdk/aws_personalize/__init__.py +46 -72
  79. aws_cdk/aws_pinpoint/__init__.py +36 -65
  80. aws_cdk/aws_quicksight/__init__.py +9972 -13374
  81. aws_cdk/aws_rds/__init__.py +53 -22
  82. aws_cdk/aws_route53/__init__.py +8 -16
  83. aws_cdk/aws_route53_targets/__init__.py +2 -4
  84. aws_cdk/aws_s3/__init__.py +41 -90
  85. aws_cdk/aws_s3_notifications/__init__.py +0 -3
  86. aws_cdk/aws_sagemaker/__init__.py +16 -10
  87. aws_cdk/aws_secretsmanager/__init__.py +17 -14
  88. aws_cdk/aws_servicecatalog/__init__.py +60 -83
  89. aws_cdk/aws_servicediscovery/__init__.py +4 -6
  90. aws_cdk/aws_ses/__init__.py +734 -28
  91. aws_cdk/aws_sns/__init__.py +4 -8
  92. aws_cdk/aws_ssm/__init__.py +19 -23
  93. aws_cdk/aws_ssmcontacts/__init__.py +10 -6
  94. aws_cdk/aws_ssmincidents/__init__.py +2 -1
  95. aws_cdk/aws_sso/__init__.py +4 -4
  96. aws_cdk/aws_stepfunctions/__init__.py +6 -15
  97. aws_cdk/aws_stepfunctions_tasks/__init__.py +51 -24
  98. aws_cdk/aws_timestream/__init__.py +22 -28
  99. aws_cdk/aws_transfer/__init__.py +188 -86
  100. aws_cdk/aws_wafv2/__init__.py +54 -38
  101. aws_cdk/aws_xray/__init__.py +15 -22
  102. aws_cdk/cloud_assembly_schema/__init__.py +14 -6
  103. aws_cdk/custom_resources/__init__.py +2 -3
  104. aws_cdk/pipelines/__init__.py +104 -134
  105. aws_cdk/triggers/__init__.py +46 -61
  106. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/METADATA +47 -92
  107. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/RECORD +111 -111
  108. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/LICENSE +0 -0
  109. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/NOTICE +0 -0
  110. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/WHEEL +0 -0
  111. {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/top_level.txt +0 -0
@@ -239,12 +239,9 @@ class CfnSuiteDefinition(
239
239
  certificate_arn: typing.Optional[builtins.str] = None,
240
240
  thing_arn: typing.Optional[builtins.str] = None,
241
241
  ) -> None:
242
- '''Information of a test device.
243
-
244
- A thing ARN or a certificate ARN is required.
245
-
246
- :param certificate_arn: Lists devices certificate ARN.
247
- :param thing_arn: Lists devices thing ARN.
242
+ '''
243
+ :param certificate_arn: ``CfnSuiteDefinition.DeviceUnderTestProperty.CertificateArn``.
244
+ :param thing_arn: ``CfnSuiteDefinition.DeviceUnderTestProperty.ThingArn``.
248
245
 
249
246
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html
250
247
  :exampleMetadata: fixture=_generated
@@ -272,7 +269,7 @@ class CfnSuiteDefinition(
272
269
 
273
270
  @builtins.property
274
271
  def certificate_arn(self) -> typing.Optional[builtins.str]:
275
- '''Lists devices certificate ARN.
272
+ '''``CfnSuiteDefinition.DeviceUnderTestProperty.CertificateArn``.
276
273
 
277
274
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html#cfn-iotcoredeviceadvisor-suitedefinition-deviceundertest-certificatearn
278
275
  '''
@@ -281,7 +278,7 @@ class CfnSuiteDefinition(
281
278
 
282
279
  @builtins.property
283
280
  def thing_arn(self) -> typing.Optional[builtins.str]:
284
- '''Lists devices thing ARN.
281
+ '''``CfnSuiteDefinition.DeviceUnderTestProperty.ThingArn``.
285
282
 
286
283
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-deviceundertest.html#cfn-iotcoredeviceadvisor-suitedefinition-deviceundertest-thingarn
287
284
  '''
@@ -320,13 +317,12 @@ class CfnSuiteDefinition(
320
317
  intended_for_qualification: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
321
318
  suite_definition_name: typing.Optional[builtins.str] = None,
322
319
  ) -> None:
323
- '''Gets the suite definition configuration.
324
-
325
- :param device_permission_role_arn: Gets the device permission ARN. This is a required parameter.
326
- :param root_group: Gets the test suite root group. This is a required parameter.
327
- :param devices: Gets the devices configured.
328
- :param intended_for_qualification: Gets the tests intended for qualification in a suite.
329
- :param suite_definition_name: Gets the suite definition name. This is a required parameter.
320
+ '''
321
+ :param device_permission_role_arn: ``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.DevicePermissionRoleArn``.
322
+ :param root_group: ``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.RootGroup``.
323
+ :param devices: ``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Devices``.
324
+ :param intended_for_qualification: ``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.IntendedForQualification``.
325
+ :param suite_definition_name: ``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.SuiteDefinitionName``.
330
326
 
331
327
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html
332
328
  :exampleMetadata: fixture=_generated
@@ -370,9 +366,7 @@ class CfnSuiteDefinition(
370
366
 
371
367
  @builtins.property
372
368
  def device_permission_role_arn(self) -> builtins.str:
373
- '''Gets the device permission ARN.
374
-
375
- This is a required parameter.
369
+ '''``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.DevicePermissionRoleArn``.
376
370
 
377
371
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-devicepermissionrolearn
378
372
  '''
@@ -382,9 +376,7 @@ class CfnSuiteDefinition(
382
376
 
383
377
  @builtins.property
384
378
  def root_group(self) -> builtins.str:
385
- '''Gets the test suite root group.
386
-
387
- This is a required parameter.
379
+ '''``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.RootGroup``.
388
380
 
389
381
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-rootgroup
390
382
  '''
@@ -396,7 +388,7 @@ class CfnSuiteDefinition(
396
388
  def devices(
397
389
  self,
398
390
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnSuiteDefinition.DeviceUnderTestProperty"]]]]:
399
- '''Gets the devices configured.
391
+ '''``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.Devices``.
400
392
 
401
393
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-devices
402
394
  '''
@@ -407,7 +399,7 @@ class CfnSuiteDefinition(
407
399
  def intended_for_qualification(
408
400
  self,
409
401
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
410
- '''Gets the tests intended for qualification in a suite.
402
+ '''``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.IntendedForQualification``.
411
403
 
412
404
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-intendedforqualification
413
405
  '''
@@ -416,9 +408,7 @@ class CfnSuiteDefinition(
416
408
 
417
409
  @builtins.property
418
410
  def suite_definition_name(self) -> typing.Optional[builtins.str]:
419
- '''Gets the suite definition name.
420
-
421
- This is a required parameter.
411
+ '''``CfnSuiteDefinition.SuiteDefinitionConfigurationProperty.SuiteDefinitionName``.
422
412
 
423
413
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration.html#cfn-iotcoredeviceadvisor-suitedefinition-suitedefinitionconfiguration-suitedefinitionname
424
414
  '''
@@ -553,7 +553,7 @@ class CfnAlarmModel(
553
553
  :param iot_site_wise: Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise . You must use expressions for all parameters in ``IotSiteWiseAction`` . The expressions accept literals, operators, functions, references, and substitutions templates. **Examples** - For literal values, the expressions must contain single quotes. For example, the value for the ``propertyAlias`` parameter can be ``'/company/windfarm/3/turbine/7/temperature'`` . - For references, you must specify either variables or input values. For example, the value for the ``assetId`` parameter can be ``$input.TurbineInput.assetId1`` . - For a substitution template, you must use ``${}`` , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the ``propertyAlias`` parameter uses a substitution template. ``'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'`` You must specify either ``propertyAlias`` or both ``assetId`` and ``propertyId`` to identify the target asset property in AWS IoT SiteWise . For more information, see `Expressions <https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html>`_ in the *AWS IoT Events Developer Guide* .
554
554
  :param iot_topic_publish: Information required to publish the MQTT message through the AWS IoT message broker.
555
555
  :param lambda_: Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
556
- :param sns: ``CfnAlarmModel.AlarmActionProperty.Sns``.
556
+ :param sns: Information required to publish the Amazon SNS message.
557
557
  :param sqs: Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
558
558
 
559
559
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html
@@ -846,7 +846,7 @@ class CfnAlarmModel(
846
846
  def sns(
847
847
  self,
848
848
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAlarmModel.SnsProperty"]]:
849
- '''``CfnAlarmModel.AlarmActionProperty.Sns``.
849
+ '''Information required to publish the Amazon SNS message.
850
850
 
851
851
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sns
852
852
  '''
@@ -1819,7 +1819,7 @@ class CfnAlarmModel(
1819
1819
  The value for the ``type`` parameter in ``Payload`` must be ``JSON`` .
1820
1820
 
1821
1821
  :param table_name: The name of the DynamoDB table.
1822
- :param payload: ``CfnAlarmModel.DynamoDBv2Property.Payload``.
1822
+ :param payload: Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression`` .
1823
1823
 
1824
1824
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html
1825
1825
  :exampleMetadata: fixture=_generated
@@ -1864,7 +1864,9 @@ class CfnAlarmModel(
1864
1864
  def payload(
1865
1865
  self,
1866
1866
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnAlarmModel.PayloadProperty"]]:
1867
- '''``CfnAlarmModel.DynamoDBv2Property.Payload``.
1867
+ '''Information needed to configure the payload.
1868
+
1869
+ By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use ``contentExpression`` .
1868
1870
 
1869
1871
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-payload
1870
1872
  '''
@@ -532,8 +532,8 @@ class CfnCampaign(
532
532
  ) -> None:
533
533
  '''Specifies what data to collect and how often or when to collect it.
534
534
 
535
- :param condition_based_collection_scheme: Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
536
- :param time_based_collection_scheme: Information about a collection scheme that uses a time period to decide how often to collect data.
535
+ :param condition_based_collection_scheme: ``CfnCampaign.CollectionSchemeProperty.ConditionBasedCollectionScheme``.
536
+ :param time_based_collection_scheme: ``CfnCampaign.CollectionSchemeProperty.TimeBasedCollectionScheme``.
537
537
 
538
538
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html
539
539
  :exampleMetadata: fixture=_generated
@@ -572,7 +572,7 @@ class CfnCampaign(
572
572
  def condition_based_collection_scheme(
573
573
  self,
574
574
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.ConditionBasedCollectionSchemeProperty"]]:
575
- '''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
575
+ '''``CfnCampaign.CollectionSchemeProperty.ConditionBasedCollectionScheme``.
576
576
 
577
577
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-conditionbasedcollectionscheme
578
578
  '''
@@ -583,7 +583,7 @@ class CfnCampaign(
583
583
  def time_based_collection_scheme(
584
584
  self,
585
585
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TimeBasedCollectionSchemeProperty"]]:
586
- '''Information about a collection scheme that uses a time period to decide how often to collect data.
586
+ '''``CfnCampaign.CollectionSchemeProperty.TimeBasedCollectionScheme``.
587
587
 
588
588
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-collectionscheme.html#cfn-iotfleetwise-campaign-collectionscheme-timebasedcollectionscheme
589
589
  '''
@@ -620,12 +620,11 @@ class CfnCampaign(
620
620
  minimum_trigger_interval_ms: typing.Optional[jsii.Number] = None,
621
621
  trigger_mode: typing.Optional[builtins.str] = None,
622
622
  ) -> None:
623
- '''Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
624
-
625
- :param expression: The logical expression used to recognize what data to collect. For example, ``$variable.Vehicle.OutsideAirTemperature >= 105.0`` .
626
- :param condition_language_version: Specifies the version of the conditional expression language.
627
- :param minimum_trigger_interval_ms: The minimum duration of time between two triggering events to collect data, in milliseconds. .. epigraph:: If a signal changes often, you might want to collect data at a slower rate.
628
- :param trigger_mode: Whether to collect data for all triggering events ( ``ALWAYS`` ). Specify ( ``RISING_EDGE`` ), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
623
+ '''
624
+ :param expression: ``CfnCampaign.ConditionBasedCollectionSchemeProperty.Expression``.
625
+ :param condition_language_version: ``CfnCampaign.ConditionBasedCollectionSchemeProperty.ConditionLanguageVersion``.
626
+ :param minimum_trigger_interval_ms: ``CfnCampaign.ConditionBasedCollectionSchemeProperty.MinimumTriggerIntervalMs``.
627
+ :param trigger_mode: ``CfnCampaign.ConditionBasedCollectionSchemeProperty.TriggerMode``.
629
628
 
630
629
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html
631
630
  :exampleMetadata: fixture=_generated
@@ -663,9 +662,7 @@ class CfnCampaign(
663
662
 
664
663
  @builtins.property
665
664
  def expression(self) -> builtins.str:
666
- '''The logical expression used to recognize what data to collect.
667
-
668
- For example, ``$variable.Vehicle.OutsideAirTemperature >= 105.0`` .
665
+ '''``CfnCampaign.ConditionBasedCollectionSchemeProperty.Expression``.
669
666
 
670
667
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-expression
671
668
  '''
@@ -675,7 +672,7 @@ class CfnCampaign(
675
672
 
676
673
  @builtins.property
677
674
  def condition_language_version(self) -> typing.Optional[jsii.Number]:
678
- '''Specifies the version of the conditional expression language.
675
+ '''``CfnCampaign.ConditionBasedCollectionSchemeProperty.ConditionLanguageVersion``.
679
676
 
680
677
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion
681
678
  '''
@@ -684,11 +681,7 @@ class CfnCampaign(
684
681
 
685
682
  @builtins.property
686
683
  def minimum_trigger_interval_ms(self) -> typing.Optional[jsii.Number]:
687
- '''The minimum duration of time between two triggering events to collect data, in milliseconds.
688
-
689
- .. epigraph::
690
-
691
- If a signal changes often, you might want to collect data at a slower rate.
684
+ '''``CfnCampaign.ConditionBasedCollectionSchemeProperty.MinimumTriggerIntervalMs``.
692
685
 
693
686
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-minimumtriggerintervalms
694
687
  '''
@@ -697,9 +690,7 @@ class CfnCampaign(
697
690
 
698
691
  @builtins.property
699
692
  def trigger_mode(self) -> typing.Optional[builtins.str]:
700
- '''Whether to collect data for all triggering events ( ``ALWAYS`` ).
701
-
702
- Specify ( ``RISING_EDGE`` ), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
693
+ '''``CfnCampaign.ConditionBasedCollectionSchemeProperty.TriggerMode``.
703
694
 
704
695
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-triggermode
705
696
  '''
@@ -820,9 +811,8 @@ class CfnCampaign(
820
811
  )
821
812
  class TimeBasedCollectionSchemeProperty:
822
813
  def __init__(self, *, period_ms: jsii.Number) -> None:
823
- '''Information about a collection scheme that uses a time period to decide how often to collect data.
824
-
825
- :param period_ms: The time period (in milliseconds) to decide how often to collect data. For example, if the time period is ``60000`` , the Edge Agent software collects data once every minute.
814
+ '''
815
+ :param period_ms: ``CfnCampaign.TimeBasedCollectionSchemeProperty.PeriodMs``.
826
816
 
827
817
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html
828
818
  :exampleMetadata: fixture=_generated
@@ -846,9 +836,7 @@ class CfnCampaign(
846
836
 
847
837
  @builtins.property
848
838
  def period_ms(self) -> jsii.Number:
849
- '''The time period (in milliseconds) to decide how often to collect data.
850
-
851
- For example, if the time period is ``60000`` , the Edge Agent software collects data once every minute.
839
+ '''``CfnCampaign.TimeBasedCollectionSchemeProperty.PeriodMs``.
852
840
 
853
841
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-timebasedcollectionscheme.html#cfn-iotfleetwise-campaign-timebasedcollectionscheme-periodms
854
842
  '''
@@ -4049,13 +4037,12 @@ class CfnSignalCatalog(
4049
4037
  total_nodes: typing.Optional[jsii.Number] = None,
4050
4038
  total_sensors: typing.Optional[jsii.Number] = None,
4051
4039
  ) -> None:
4052
- '''Information about the number of nodes and node types in a vehicle network.
4053
-
4054
- :param total_actuators: The total number of nodes in a vehicle network that represent actuators.
4055
- :param total_attributes: The total number of nodes in a vehicle network that represent attributes.
4056
- :param total_branches: The total number of nodes in a vehicle network that represent branches.
4057
- :param total_nodes: The total number of nodes in a vehicle network.
4058
- :param total_sensors: The total number of nodes in a vehicle network that represent sensors.
4040
+ '''
4041
+ :param total_actuators: ``CfnSignalCatalog.NodeCountsProperty.TotalActuators``.
4042
+ :param total_attributes: ``CfnSignalCatalog.NodeCountsProperty.TotalAttributes``.
4043
+ :param total_branches: ``CfnSignalCatalog.NodeCountsProperty.TotalBranches``.
4044
+ :param total_nodes: ``CfnSignalCatalog.NodeCountsProperty.TotalNodes``.
4045
+ :param total_sensors: ``CfnSignalCatalog.NodeCountsProperty.TotalSensors``.
4059
4046
 
4060
4047
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html
4061
4048
  :exampleMetadata: fixture=_generated
@@ -4095,7 +4082,7 @@ class CfnSignalCatalog(
4095
4082
 
4096
4083
  @builtins.property
4097
4084
  def total_actuators(self) -> typing.Optional[jsii.Number]:
4098
- '''The total number of nodes in a vehicle network that represent actuators.
4085
+ '''``CfnSignalCatalog.NodeCountsProperty.TotalActuators``.
4099
4086
 
4100
4087
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalactuators
4101
4088
  '''
@@ -4104,7 +4091,7 @@ class CfnSignalCatalog(
4104
4091
 
4105
4092
  @builtins.property
4106
4093
  def total_attributes(self) -> typing.Optional[jsii.Number]:
4107
- '''The total number of nodes in a vehicle network that represent attributes.
4094
+ '''``CfnSignalCatalog.NodeCountsProperty.TotalAttributes``.
4108
4095
 
4109
4096
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalattributes
4110
4097
  '''
@@ -4113,7 +4100,7 @@ class CfnSignalCatalog(
4113
4100
 
4114
4101
  @builtins.property
4115
4102
  def total_branches(self) -> typing.Optional[jsii.Number]:
4116
- '''The total number of nodes in a vehicle network that represent branches.
4103
+ '''``CfnSignalCatalog.NodeCountsProperty.TotalBranches``.
4117
4104
 
4118
4105
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalbranches
4119
4106
  '''
@@ -4122,7 +4109,7 @@ class CfnSignalCatalog(
4122
4109
 
4123
4110
  @builtins.property
4124
4111
  def total_nodes(self) -> typing.Optional[jsii.Number]:
4125
- '''The total number of nodes in a vehicle network.
4112
+ '''``CfnSignalCatalog.NodeCountsProperty.TotalNodes``.
4126
4113
 
4127
4114
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalnodes
4128
4115
  '''
@@ -4131,7 +4118,7 @@ class CfnSignalCatalog(
4131
4118
 
4132
4119
  @builtins.property
4133
4120
  def total_sensors(self) -> typing.Optional[jsii.Number]:
4134
- '''The total number of nodes in a vehicle network that represent sensors.
4121
+ '''``CfnSignalCatalog.NodeCountsProperty.TotalSensors``.
4135
4122
 
4136
4123
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalsensors
4137
4124
  '''
@@ -4499,9 +4499,12 @@ class CfnPortal(
4499
4499
  alarm_role_arn: typing.Optional[builtins.str] = None,
4500
4500
  notification_lambda_arn: typing.Optional[builtins.str] = None,
4501
4501
  ) -> None:
4502
- '''
4503
- :param alarm_role_arn: ``CfnPortal.AlarmsProperty.AlarmRoleArn``.
4504
- :param notification_lambda_arn: ``CfnPortal.AlarmsProperty.NotificationLambdaArn``.
4502
+ '''Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
4503
+
4504
+ You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see `Monitoring with alarms <https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html>`_ in the *AWS IoT SiteWise Application Guide* .
4505
+
4506
+ :param alarm_role_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .
4507
+ :param notification_lambda_arn: The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Lambda function that manages alarm notifications. For more information, see `Managing alarm notifications <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ in the *AWS IoT Events Developer Guide* .
4505
4508
 
4506
4509
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html
4507
4510
  :exampleMetadata: fixture=_generated
@@ -4529,7 +4532,7 @@ class CfnPortal(
4529
4532
 
4530
4533
  @builtins.property
4531
4534
  def alarm_role_arn(self) -> typing.Optional[builtins.str]:
4532
- '''``CfnPortal.AlarmsProperty.AlarmRoleArn``.
4535
+ '''The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the IAM role that allows the alarm to perform actions and access AWS resources and services, such as AWS IoT Events .
4533
4536
 
4534
4537
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-alarmrolearn
4535
4538
  '''
@@ -4538,7 +4541,7 @@ class CfnPortal(
4538
4541
 
4539
4542
  @builtins.property
4540
4543
  def notification_lambda_arn(self) -> typing.Optional[builtins.str]:
4541
- '''``CfnPortal.AlarmsProperty.NotificationLambdaArn``.
4544
+ '''The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`_ of the Lambda function that manages alarm notifications. For more information, see `Managing alarm notifications <https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html>`_ in the *AWS IoT Events Developer Guide* .
4542
4545
 
4543
4546
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-portal-alarms.html#cfn-iotsitewise-portal-alarms-notificationlambdaarn
4544
4547
  '''
@@ -2436,9 +2436,10 @@ class CfnNetworkAnalyzerConfiguration(
2436
2436
  log_level: typing.Optional[builtins.str] = None,
2437
2437
  wireless_device_frame_info: typing.Optional[builtins.str] = None,
2438
2438
  ) -> None:
2439
- '''
2440
- :param log_level: ``CfnNetworkAnalyzerConfiguration.TraceContentProperty.LogLevel``.
2441
- :param wireless_device_frame_info: ``CfnNetworkAnalyzerConfiguration.TraceContentProperty.WirelessDeviceFrameInfo``.
2439
+ '''Trace content for your wireless gateway and wireless device resources.
2440
+
2441
+ :param log_level: The log level for a log message. The log levels can be disabled, or set to ``ERROR`` to display less verbose logs containing only error information, or to ``INFO`` for more detailed logs
2442
+ :param wireless_device_frame_info: ``FrameInfo`` of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.
2442
2443
 
2443
2444
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html
2444
2445
  :exampleMetadata: fixture=_generated
@@ -2466,7 +2467,9 @@ class CfnNetworkAnalyzerConfiguration(
2466
2467
 
2467
2468
  @builtins.property
2468
2469
  def log_level(self) -> typing.Optional[builtins.str]:
2469
- '''``CfnNetworkAnalyzerConfiguration.TraceContentProperty.LogLevel``.
2470
+ '''The log level for a log message.
2471
+
2472
+ The log levels can be disabled, or set to ``ERROR`` to display less verbose logs containing only error information, or to ``INFO`` for more detailed logs
2470
2473
 
2471
2474
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-loglevel
2472
2475
  '''
@@ -2475,7 +2478,9 @@ class CfnNetworkAnalyzerConfiguration(
2475
2478
 
2476
2479
  @builtins.property
2477
2480
  def wireless_device_frame_info(self) -> typing.Optional[builtins.str]:
2478
- '''``CfnNetworkAnalyzerConfiguration.TraceContentProperty.WirelessDeviceFrameInfo``.
2481
+ '''``FrameInfo`` of your wireless device resources for the trace content.
2482
+
2483
+ Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.
2479
2484
 
2480
2485
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-networkanalyzerconfiguration-tracecontent.html#cfn-iotwireless-networkanalyzerconfiguration-tracecontent-wirelessdeviceframeinfo
2481
2486
  '''
@@ -4214,7 +4219,7 @@ class CfnTaskDefinition(
4214
4219
 
4215
4220
  :param scope: - scope in which this resource is defined.
4216
4221
  :param id: - scoped id of the resource.
4217
- :param auto_create_tasks: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If ``false`` , the task must be created by calling ``CreateWirelessGatewayTask`` .
4222
+ :param auto_create_tasks: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If ``false`` , the task must me created by calling ``CreateWirelessGatewayTask`` .
4218
4223
  :param lo_ra_wan_update_gateway_task_entry: ``AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry``.
4219
4224
  :param name: The name of the new resource.
4220
4225
  :param tags: The tags are an array of key-value pairs to attach to the specified resource. Tags can have a minimum of 0 and a maximum of 50 items.
@@ -4305,7 +4310,7 @@ class CfnTaskDefinition(
4305
4310
  def auto_create_tasks(self) -> typing.Union[builtins.bool, _IResolvable_da3f097b]:
4306
4311
  '''Whether to automatically create tasks using this task definition for all gateways with the specified current version.
4307
4312
 
4308
- If ``false`` , the task must be created by calling ``CreateWirelessGatewayTask`` .
4313
+ If ``false`` , the task must me created by calling ``CreateWirelessGatewayTask`` .
4309
4314
 
4310
4315
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-autocreatetasks
4311
4316
  '''
@@ -4816,7 +4821,7 @@ class CfnTaskDefinitionProps:
4816
4821
  ) -> None:
4817
4822
  '''Properties for defining a ``CfnTaskDefinition``.
4818
4823
 
4819
- :param auto_create_tasks: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If ``false`` , the task must be created by calling ``CreateWirelessGatewayTask`` .
4824
+ :param auto_create_tasks: Whether to automatically create tasks using this task definition for all gateways with the specified current version. If ``false`` , the task must me created by calling ``CreateWirelessGatewayTask`` .
4820
4825
  :param lo_ra_wan_update_gateway_task_entry: ``AWS::IoTWireless::TaskDefinition.LoRaWANUpdateGatewayTaskEntry``.
4821
4826
  :param name: The name of the new resource.
4822
4827
  :param tags: The tags are an array of key-value pairs to attach to the specified resource. Tags can have a minimum of 0 and a maximum of 50 items.
@@ -4900,7 +4905,7 @@ class CfnTaskDefinitionProps:
4900
4905
  def auto_create_tasks(self) -> typing.Union[builtins.bool, _IResolvable_da3f097b]:
4901
4906
  '''Whether to automatically create tasks using this task definition for all gateways with the specified current version.
4902
4907
 
4903
- If ``false`` , the task must be created by calling ``CreateWirelessGatewayTask`` .
4908
+ If ``false`` , the task must me created by calling ``CreateWirelessGatewayTask`` .
4904
4909
 
4905
4910
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotwireless-taskdefinition.html#cfn-iotwireless-taskdefinition-autocreatetasks
4906
4911
  '''
@@ -1025,10 +1025,9 @@ class CfnDeliveryStream(
1025
1025
  interval_in_seconds: typing.Optional[jsii.Number] = None,
1026
1026
  size_in_m_bs: typing.Optional[jsii.Number] = None,
1027
1027
  ) -> None:
1028
- '''Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
1029
-
1030
- :param interval_in_seconds: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
1031
- :param size_in_m_bs: Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
1028
+ '''
1029
+ :param interval_in_seconds: ``CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty.IntervalInSeconds``.
1030
+ :param size_in_m_bs: ``CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty.SizeInMBs``.
1032
1031
 
1033
1032
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html
1034
1033
  :exampleMetadata: fixture=_generated
@@ -1056,9 +1055,7 @@ class CfnDeliveryStream(
1056
1055
 
1057
1056
  @builtins.property
1058
1057
  def interval_in_seconds(self) -> typing.Optional[jsii.Number]:
1059
- '''Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
1060
-
1061
- The default value is 300 (5 minutes).
1058
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty.IntervalInSeconds``.
1062
1059
 
1063
1060
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-intervalinseconds
1064
1061
  '''
@@ -1067,11 +1064,7 @@ class CfnDeliveryStream(
1067
1064
 
1068
1065
  @builtins.property
1069
1066
  def size_in_m_bs(self) -> typing.Optional[jsii.Number]:
1070
- '''Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
1071
-
1072
- The default value is 5.
1073
-
1074
- We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
1067
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty.SizeInMBs``.
1075
1068
 
1076
1069
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessbufferinghints-sizeinmbs
1077
1070
  '''
@@ -1120,17 +1113,16 @@ class CfnDeliveryStream(
1120
1113
  s3_backup_mode: typing.Optional[builtins.str] = None,
1121
1114
  vpc_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.VpcConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
1122
1115
  ) -> None:
1123
- '''Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
1124
-
1125
- :param index_name: The Serverless offering for Amazon OpenSearch Service index name.
1126
- :param role_arn: The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
1116
+ '''
1117
+ :param index_name: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName``.
1118
+ :param role_arn: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN``.
1127
1119
  :param s3_configuration: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration``.
1128
- :param buffering_hints: The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
1120
+ :param buffering_hints: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints``.
1129
1121
  :param cloud_watch_logging_options: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions``.
1130
- :param collection_endpoint: The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
1122
+ :param collection_endpoint: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint``.
1131
1123
  :param processing_configuration: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration``.
1132
- :param retry_options: The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
1133
- :param s3_backup_mode: Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
1124
+ :param retry_options: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions``.
1125
+ :param s3_backup_mode: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode``.
1134
1126
  :param vpc_configuration: ``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration``.
1135
1127
 
1136
1128
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html
@@ -1238,7 +1230,7 @@ class CfnDeliveryStream(
1238
1230
 
1239
1231
  @builtins.property
1240
1232
  def index_name(self) -> builtins.str:
1241
- '''The Serverless offering for Amazon OpenSearch Service index name.
1233
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName``.
1242
1234
 
1243
1235
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-indexname
1244
1236
  '''
@@ -1248,7 +1240,7 @@ class CfnDeliveryStream(
1248
1240
 
1249
1241
  @builtins.property
1250
1242
  def role_arn(self) -> builtins.str:
1251
- '''The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
1243
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN``.
1252
1244
 
1253
1245
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn
1254
1246
  '''
@@ -1272,9 +1264,7 @@ class CfnDeliveryStream(
1272
1264
  def buffering_hints(
1273
1265
  self,
1274
1266
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsProperty"]]:
1275
- '''The buffering options.
1276
-
1277
- If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
1267
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints``.
1278
1268
 
1279
1269
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-bufferinghints
1280
1270
  '''
@@ -1294,7 +1284,7 @@ class CfnDeliveryStream(
1294
1284
 
1295
1285
  @builtins.property
1296
1286
  def collection_endpoint(self) -> typing.Optional[builtins.str]:
1297
- '''The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
1287
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint``.
1298
1288
 
1299
1289
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-collectionendpoint
1300
1290
  '''
@@ -1316,9 +1306,7 @@ class CfnDeliveryStream(
1316
1306
  def retry_options(
1317
1307
  self,
1318
1308
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty"]]:
1319
- '''The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
1320
-
1321
- The default value is 300 (5 minutes).
1309
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions``.
1322
1310
 
1323
1311
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-retryoptions
1324
1312
  '''
@@ -1327,9 +1315,7 @@ class CfnDeliveryStream(
1327
1315
 
1328
1316
  @builtins.property
1329
1317
  def s3_backup_mode(self) -> typing.Optional[builtins.str]:
1330
- '''Defines how documents should be delivered to Amazon S3.
1331
-
1332
- When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
1318
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode``.
1333
1319
 
1334
1320
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode
1335
1321
  '''
@@ -1369,9 +1355,8 @@ class CfnDeliveryStream(
1369
1355
  *,
1370
1356
  duration_in_seconds: typing.Optional[jsii.Number] = None,
1371
1357
  ) -> None:
1372
- '''Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
1373
-
1374
- :param duration_in_seconds: After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
1358
+ '''
1359
+ :param duration_in_seconds: ``CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty.DurationInSeconds``.
1375
1360
 
1376
1361
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html
1377
1362
  :exampleMetadata: fixture=_generated
@@ -1395,9 +1380,7 @@ class CfnDeliveryStream(
1395
1380
 
1396
1381
  @builtins.property
1397
1382
  def duration_in_seconds(self) -> typing.Optional[jsii.Number]:
1398
- '''After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt).
1399
-
1400
- After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
1383
+ '''``CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty.DurationInSeconds``.
1401
1384
 
1402
1385
  :link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions-durationinseconds
1403
1386
  '''