aws-cdk-lib 2.105.0__py3-none-any.whl → 2.106.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.

Files changed (47) hide show
  1. aws_cdk/__init__.py +59 -69
  2. aws_cdk/_jsii/__init__.py +1 -1
  3. aws_cdk/_jsii/{aws-cdk-lib@2.105.0.jsii.tgz → aws-cdk-lib@2.106.1.jsii.tgz} +0 -0
  4. aws_cdk/aws_amplify/__init__.py +12 -12
  5. aws_cdk/aws_appconfig/__init__.py +25 -11
  6. aws_cdk/aws_appintegrations/__init__.py +60 -60
  7. aws_cdk/aws_apprunner/__init__.py +22 -3
  8. aws_cdk/aws_appstream/__init__.py +12 -5
  9. aws_cdk/aws_appsync/__init__.py +4 -4
  10. aws_cdk/aws_autoscaling/__init__.py +8 -0
  11. aws_cdk/aws_cloudformation/__init__.py +59 -69
  12. aws_cdk/aws_codepipeline/__init__.py +3 -0
  13. aws_cdk/aws_cognito/__init__.py +23 -31
  14. aws_cdk/aws_config/__init__.py +46 -41
  15. aws_cdk/aws_datapipeline/__init__.py +54 -54
  16. aws_cdk/aws_directoryservice/__init__.py +45 -45
  17. aws_cdk/aws_ec2/__init__.py +163 -21
  18. aws_cdk/aws_ecs/__init__.py +52 -68
  19. aws_cdk/aws_eks/__init__.py +55 -9
  20. aws_cdk/aws_entityresolution/__init__.py +9 -0
  21. aws_cdk/aws_events/__init__.py +0 -8
  22. aws_cdk/aws_eventschemas/__init__.py +12 -12
  23. aws_cdk/aws_gamelift/__init__.py +4 -6
  24. aws_cdk/aws_internetmonitor/__init__.py +12 -10
  25. aws_cdk/aws_iot/__init__.py +10 -11
  26. aws_cdk/aws_lakeformation/__init__.py +8 -5
  27. aws_cdk/aws_lambda/__init__.py +30 -0
  28. aws_cdk/aws_msk/__init__.py +3 -3
  29. aws_cdk/aws_networkmanager/__init__.py +1 -1
  30. aws_cdk/aws_pinpoint/__init__.py +94 -94
  31. aws_cdk/aws_quicksight/__init__.py +189 -264
  32. aws_cdk/aws_rds/__init__.py +267 -36
  33. aws_cdk/aws_rolesanywhere/__init__.py +53 -41
  34. aws_cdk/aws_route53/__init__.py +3 -7
  35. aws_cdk/aws_s3/__init__.py +191 -2
  36. aws_cdk/aws_sam/__init__.py +42 -47
  37. aws_cdk/aws_servicecatalogappregistry/__init__.py +2 -4
  38. aws_cdk/aws_ssm/__init__.py +4 -4
  39. aws_cdk/aws_stepfunctions_tasks/__init__.py +9 -2
  40. aws_cdk/aws_vpclattice/__init__.py +2 -6
  41. aws_cdk/aws_wafv2/__init__.py +21 -8
  42. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/METADATA +3 -3
  43. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/RECORD +47 -47
  44. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/LICENSE +0 -0
  45. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/NOTICE +0 -0
  46. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/WHEEL +0 -0
  47. {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/top_level.txt +0 -0
@@ -146,7 +146,10 @@ class CfnADMChannel(
146
146
  @builtins.property
147
147
  @jsii.member(jsii_name="attrId")
148
148
  def attr_id(self) -> builtins.str:
149
- '''
149
+ '''(Deprecated) An identifier for the ADM channel.
150
+
151
+ This property is retained only for backward compatibility.
152
+
150
153
  :cloudformationAttribute: Id
151
154
  '''
152
155
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -441,7 +444,10 @@ class CfnAPNSChannel(
441
444
  @builtins.property
442
445
  @jsii.member(jsii_name="attrId")
443
446
  def attr_id(self) -> builtins.str:
444
- '''
447
+ '''(Deprecated) An identifier for the APNs channel.
448
+
449
+ This property is retained only for backward compatibility.
450
+
445
451
  :cloudformationAttribute: Id
446
452
  '''
447
453
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -894,7 +900,10 @@ class CfnAPNSSandboxChannel(
894
900
  @builtins.property
895
901
  @jsii.member(jsii_name="attrId")
896
902
  def attr_id(self) -> builtins.str:
897
- '''
903
+ '''(Deprecated) An identifier for the APNs sandbox channel.
904
+
905
+ This property is retained only for backward compatibility.
906
+
898
907
  :cloudformationAttribute: Id
899
908
  '''
900
909
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -1347,7 +1356,10 @@ class CfnAPNSVoipChannel(
1347
1356
  @builtins.property
1348
1357
  @jsii.member(jsii_name="attrId")
1349
1358
  def attr_id(self) -> builtins.str:
1350
- '''
1359
+ '''(Deprecated) An identifier for the APNs VoIP channel.
1360
+
1361
+ This property is retained only for backward compatibility.
1362
+
1351
1363
  :cloudformationAttribute: Id
1352
1364
  '''
1353
1365
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -1800,7 +1812,10 @@ class CfnAPNSVoipSandboxChannel(
1800
1812
  @builtins.property
1801
1813
  @jsii.member(jsii_name="attrId")
1802
1814
  def attr_id(self) -> builtins.str:
1803
- '''
1815
+ '''(Deprecated) An identifier for the APNs VoIP sandbox channel.
1816
+
1817
+ This property is retained only for backward compatibility.
1818
+
1804
1819
  :cloudformationAttribute: Id
1805
1820
  '''
1806
1821
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -2233,7 +2248,10 @@ class CfnApp(
2233
2248
  @builtins.property
2234
2249
  @jsii.member(jsii_name="attrId")
2235
2250
  def attr_id(self) -> builtins.str:
2236
- '''
2251
+ '''The unique identifier for the application.
2252
+
2253
+ This identifier is displayed as the *Project ID* on the Amazon Pinpoint console.
2254
+
2237
2255
  :cloudformationAttribute: Id
2238
2256
  '''
2239
2257
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -2408,7 +2426,7 @@ class CfnApplicationSettings(
2408
2426
  :param id: Construct identifier for this resource (unique in its scope).
2409
2427
  :param application_id: The unique identifier for the Amazon Pinpoint application.
2410
2428
  :param campaign_hook: The settings for the Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
2411
- :param cloud_watch_metrics_enabled: Specifies whether to enable application-related alarms in Amazon CloudWatch.
2429
+ :param cloud_watch_metrics_enabled:
2412
2430
  :param limits: The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
2413
2431
  :param quiet_time: The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met: - The ``EndpointDemographic.Timezone`` property of the endpoint is set to a valid value. - The current time in the endpoint's time zone is later than or equal to the time specified by the ``QuietTime.Start`` property for the application (or a campaign that has custom quiet time settings). - The current time in the endpoint's time zone is earlier than or equal to the time specified by the ``QuietTime.End`` property for the application (or a campaign that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled. To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
2414
2432
  '''
@@ -2505,7 +2523,6 @@ class CfnApplicationSettings(
2505
2523
  def cloud_watch_metrics_enabled(
2506
2524
  self,
2507
2525
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
2508
- '''Specifies whether to enable application-related alarms in Amazon CloudWatch.'''
2509
2526
  return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "cloudWatchMetricsEnabled"))
2510
2527
 
2511
2528
  @cloud_watch_metrics_enabled.setter
@@ -2855,7 +2872,7 @@ class CfnApplicationSettingsProps:
2855
2872
 
2856
2873
  :param application_id: The unique identifier for the Amazon Pinpoint application.
2857
2874
  :param campaign_hook: The settings for the Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
2858
- :param cloud_watch_metrics_enabled: Specifies whether to enable application-related alarms in Amazon CloudWatch.
2875
+ :param cloud_watch_metrics_enabled:
2859
2876
  :param limits: The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
2860
2877
  :param quiet_time: The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met: - The ``EndpointDemographic.Timezone`` property of the endpoint is set to a valid value. - The current time in the endpoint's time zone is later than or equal to the time specified by the ``QuietTime.Start`` property for the application (or a campaign that has custom quiet time settings). - The current time in the endpoint's time zone is earlier than or equal to the time specified by the ``QuietTime.End`` property for the application (or a campaign that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled. To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
2861
2878
 
@@ -2936,8 +2953,7 @@ class CfnApplicationSettingsProps:
2936
2953
  def cloud_watch_metrics_enabled(
2937
2954
  self,
2938
2955
  ) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
2939
- '''Specifies whether to enable application-related alarms in Amazon CloudWatch.
2940
-
2956
+ '''
2941
2957
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled
2942
2958
  '''
2943
2959
  result = self._values.get("cloud_watch_metrics_enabled")
@@ -3085,7 +3101,10 @@ class CfnBaiduChannel(
3085
3101
  @builtins.property
3086
3102
  @jsii.member(jsii_name="attrId")
3087
3103
  def attr_id(self) -> builtins.str:
3088
- '''
3104
+ '''(Deprecated) An identifier for the Baidu channel.
3105
+
3106
+ This property is retained only for backward compatibility.
3107
+
3089
3108
  :cloudformationAttribute: Id
3090
3109
  '''
3091
3110
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -3742,7 +3761,7 @@ class CfnCampaign(
3742
3761
  :param id: Construct identifier for this resource (unique in its scope).
3743
3762
  :param application_id: The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
3744
3763
  :param name: The name of the campaign.
3745
- :param schedule: The schedule settings for the campaign.
3764
+ :param schedule: The schedule settings for the treatment.
3746
3765
  :param segment_id: The unique identifier for the segment to associate with the campaign.
3747
3766
  :param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
3748
3767
  :param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
@@ -3751,13 +3770,13 @@ class CfnCampaign(
3751
3770
  :param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
3752
3771
  :param is_paused: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to ``false`` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.
3753
3772
  :param limits: The messaging limits for the campaign.
3754
- :param message_configuration: The message configuration settings for the campaign.
3773
+ :param message_configuration: The message configuration settings for the treatment.
3755
3774
  :param priority: An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
3756
3775
  :param segment_version: The version of the segment to associate with the campaign.
3757
3776
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
3758
3777
  :param template_configuration: The message template to use for the treatment.
3759
- :param treatment_description: A custom description of the default treatment for the campaign.
3760
- :param treatment_name: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A *treatment* is a variation of a campaign that's used for A/B testing.
3778
+ :param treatment_description: A custom description of the treatment.
3779
+ :param treatment_name: A custom name for the treatment.
3761
3780
  '''
3762
3781
  if __debug__:
3763
3782
  type_hints = typing.get_type_hints(_typecheckingstub__37daefd9aecddac1551b6da8a771d74af1f7a13678f1d1fb2d351fab8d081055)
@@ -3876,7 +3895,7 @@ class CfnCampaign(
3876
3895
  def schedule(
3877
3896
  self,
3878
3897
  ) -> typing.Union[_IResolvable_da3f097b, "CfnCampaign.ScheduleProperty"]:
3879
- '''The schedule settings for the campaign.'''
3898
+ '''The schedule settings for the treatment.'''
3880
3899
  return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnCampaign.ScheduleProperty"], jsii.get(self, "schedule"))
3881
3900
 
3882
3901
  @schedule.setter
@@ -4023,7 +4042,7 @@ class CfnCampaign(
4023
4042
  def message_configuration(
4024
4043
  self,
4025
4044
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.MessageConfigurationProperty"]]:
4026
- '''The message configuration settings for the campaign.'''
4045
+ '''The message configuration settings for the treatment.'''
4027
4046
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.MessageConfigurationProperty"]], jsii.get(self, "messageConfiguration"))
4028
4047
 
4029
4048
  @message_configuration.setter
@@ -4096,7 +4115,7 @@ class CfnCampaign(
4096
4115
  @builtins.property
4097
4116
  @jsii.member(jsii_name="treatmentDescription")
4098
4117
  def treatment_description(self) -> typing.Optional[builtins.str]:
4099
- '''A custom description of the default treatment for the campaign.'''
4118
+ '''A custom description of the treatment.'''
4100
4119
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "treatmentDescription"))
4101
4120
 
4102
4121
  @treatment_description.setter
@@ -4109,7 +4128,7 @@ class CfnCampaign(
4109
4128
  @builtins.property
4110
4129
  @jsii.member(jsii_name="treatmentName")
4111
4130
  def treatment_name(self) -> typing.Optional[builtins.str]:
4112
- '''A custom name of the default treatment for the campaign, if the campaign has multiple treatments.'''
4131
+ '''A custom name for the treatment.'''
4113
4132
  return typing.cast(typing.Optional[builtins.str], jsii.get(self, "treatmentName"))
4114
4133
 
4115
4134
  @treatment_name.setter
@@ -4131,10 +4150,9 @@ class CfnCampaign(
4131
4150
  attribute_type: typing.Optional[builtins.str] = None,
4132
4151
  values: typing.Optional[typing.Sequence[builtins.str]] = None,
4133
4152
  ) -> None:
4134
- '''Specifies attribute-based criteria for including or excluding endpoints from a segment.
4135
-
4136
- :param attribute_type: The type of segment dimension to use. Valid values are:. - ``INCLUSIVE`` – endpoints that have attributes matching the values are included in the segment. - ``EXCLUSIVE`` – endpoints that have attributes matching the values are excluded from the segment. - ``CONTAINS`` – endpoints that have attributes' substrings match the values are included in the segment. - ``BEFORE`` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. - ``AFTER`` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. - ``BETWEEN`` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment. - ``ON`` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
4137
- :param values: The criteria values to use for the segment dimension. Depending on the value of the ``AttributeType`` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
4153
+ '''
4154
+ :param attribute_type:
4155
+ :param values:
4138
4156
 
4139
4157
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html
4140
4158
  :exampleMetadata: fixture=_generated
@@ -4162,16 +4180,7 @@ class CfnCampaign(
4162
4180
 
4163
4181
  @builtins.property
4164
4182
  def attribute_type(self) -> typing.Optional[builtins.str]:
4165
- '''The type of segment dimension to use. Valid values are:.
4166
-
4167
- - ``INCLUSIVE`` – endpoints that have attributes matching the values are included in the segment.
4168
- - ``EXCLUSIVE`` – endpoints that have attributes matching the values are excluded from the segment.
4169
- - ``CONTAINS`` – endpoints that have attributes' substrings match the values are included in the segment.
4170
- - ``BEFORE`` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
4171
- - ``AFTER`` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
4172
- - ``BETWEEN`` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
4173
- - ``ON`` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
4174
-
4183
+ '''
4175
4184
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-attributetype
4176
4185
  '''
4177
4186
  result = self._values.get("attribute_type")
@@ -4179,10 +4188,7 @@ class CfnCampaign(
4179
4188
 
4180
4189
  @builtins.property
4181
4190
  def values(self) -> typing.Optional[typing.List[builtins.str]]:
4182
- '''The criteria values to use for the segment dimension.
4183
-
4184
- Depending on the value of the ``AttributeType`` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
4185
-
4191
+ '''
4186
4192
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-values
4187
4193
  '''
4188
4194
  result = self._values.get("values")
@@ -6420,12 +6426,9 @@ class CfnCampaign(
6420
6426
  comparison_operator: typing.Optional[builtins.str] = None,
6421
6427
  value: typing.Optional[jsii.Number] = None,
6422
6428
  ) -> None:
6423
- '''Specifies metric-based criteria for including or excluding endpoints from a segment.
6424
-
6425
- These criteria derive from custom metrics that you define for endpoints.
6426
-
6427
- :param comparison_operator: The operator to use when comparing metric values. Valid values are: ``GREATER_THAN`` , ``LESS_THAN`` , ``GREATER_THAN_OR_EQUAL`` , ``LESS_THAN_OR_EQUAL`` , and ``EQUAL`` .
6428
- :param value: The value to compare.
6429
+ '''
6430
+ :param comparison_operator:
6431
+ :param value:
6429
6432
 
6430
6433
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html
6431
6434
  :exampleMetadata: fixture=_generated
@@ -6453,10 +6456,7 @@ class CfnCampaign(
6453
6456
 
6454
6457
  @builtins.property
6455
6458
  def comparison_operator(self) -> typing.Optional[builtins.str]:
6456
- '''The operator to use when comparing metric values.
6457
-
6458
- Valid values are: ``GREATER_THAN`` , ``LESS_THAN`` , ``GREATER_THAN_OR_EQUAL`` , ``LESS_THAN_OR_EQUAL`` , and ``EQUAL`` .
6459
-
6459
+ '''
6460
6460
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-comparisonoperator
6461
6461
  '''
6462
6462
  result = self._values.get("comparison_operator")
@@ -6464,8 +6464,7 @@ class CfnCampaign(
6464
6464
 
6465
6465
  @builtins.property
6466
6466
  def value(self) -> typing.Optional[jsii.Number]:
6467
- '''The value to compare.
6468
-
6467
+ '''
6469
6468
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-value
6470
6469
  '''
6471
6470
  result = self._values.get("value")
@@ -7506,7 +7505,7 @@ class CfnCampaignProps:
7506
7505
 
7507
7506
  :param application_id: The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
7508
7507
  :param name: The name of the campaign.
7509
- :param schedule: The schedule settings for the campaign.
7508
+ :param schedule: The schedule settings for the treatment.
7510
7509
  :param segment_id: The unique identifier for the segment to associate with the campaign.
7511
7510
  :param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
7512
7511
  :param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
@@ -7515,13 +7514,13 @@ class CfnCampaignProps:
7515
7514
  :param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
7516
7515
  :param is_paused: Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to ``false`` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.
7517
7516
  :param limits: The messaging limits for the campaign.
7518
- :param message_configuration: The message configuration settings for the campaign.
7517
+ :param message_configuration: The message configuration settings for the treatment.
7519
7518
  :param priority: An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
7520
7519
  :param segment_version: The version of the segment to associate with the campaign.
7521
7520
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
7522
7521
  :param template_configuration: The message template to use for the treatment.
7523
- :param treatment_description: A custom description of the default treatment for the campaign.
7524
- :param treatment_name: A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A *treatment* is a variation of a campaign that's used for A/B testing.
7522
+ :param treatment_description: A custom description of the treatment.
7523
+ :param treatment_name: A custom name for the treatment.
7525
7524
 
7526
7525
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html
7527
7526
  :exampleMetadata: fixture=_generated
@@ -8039,7 +8038,7 @@ class CfnCampaignProps:
8039
8038
  def schedule(
8040
8039
  self,
8041
8040
  ) -> typing.Union[_IResolvable_da3f097b, CfnCampaign.ScheduleProperty]:
8042
- '''The schedule settings for the campaign.
8041
+ '''The schedule settings for the treatment.
8043
8042
 
8044
8043
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule
8045
8044
  '''
@@ -8138,7 +8137,7 @@ class CfnCampaignProps:
8138
8137
  def message_configuration(
8139
8138
  self,
8140
8139
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnCampaign.MessageConfigurationProperty]]:
8141
- '''The message configuration settings for the campaign.
8140
+ '''The message configuration settings for the treatment.
8142
8141
 
8143
8142
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration
8144
8143
  '''
@@ -8189,7 +8188,7 @@ class CfnCampaignProps:
8189
8188
 
8190
8189
  @builtins.property
8191
8190
  def treatment_description(self) -> typing.Optional[builtins.str]:
8192
- '''A custom description of the default treatment for the campaign.
8191
+ '''A custom description of the treatment.
8193
8192
 
8194
8193
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription
8195
8194
  '''
@@ -8198,9 +8197,7 @@ class CfnCampaignProps:
8198
8197
 
8199
8198
  @builtins.property
8200
8199
  def treatment_name(self) -> typing.Optional[builtins.str]:
8201
- '''A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
8202
-
8203
- A *treatment* is a variation of a campaign that's used for A/B testing.
8200
+ '''A custom name for the treatment.
8204
8201
 
8205
8202
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname
8206
8203
  '''
@@ -8323,7 +8320,10 @@ class CfnEmailChannel(
8323
8320
  @builtins.property
8324
8321
  @jsii.member(jsii_name="attrId")
8325
8322
  def attr_id(self) -> builtins.str:
8326
- '''
8323
+ '''(Deprecated) An identifier for the email channel.
8324
+
8325
+ This property is retained only for backward compatibility.
8326
+
8327
8327
  :cloudformationAttribute: Id
8328
8328
  '''
8329
8329
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -9273,7 +9273,10 @@ class CfnGCMChannel(
9273
9273
  @builtins.property
9274
9274
  @jsii.member(jsii_name="attrId")
9275
9275
  def attr_id(self) -> builtins.str:
9276
- '''
9276
+ '''(Deprecated) An identifier for the GCM channel.
9277
+
9278
+ This property is retained only for backward compatibility.
9279
+
9277
9280
  :cloudformationAttribute: Id
9278
9281
  '''
9279
9282
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -10731,7 +10734,7 @@ class CfnPushTemplate(
10731
10734
  '''
10732
10735
  :param scope: Scope in which this resource is defined.
10733
10736
  :param id: Construct identifier for this resource (unique in its scope).
10734
- :param template_name: The name of the message template.
10737
+ :param template_name: The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
10735
10738
  :param adm: The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
10736
10739
  :param apns: The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
10737
10740
  :param baidu: The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
@@ -10820,7 +10823,7 @@ class CfnPushTemplate(
10820
10823
  @builtins.property
10821
10824
  @jsii.member(jsii_name="templateName")
10822
10825
  def template_name(self) -> builtins.str:
10823
- '''The name of the message template.'''
10826
+ '''The name of the message template to use for the message.'''
10824
10827
  return typing.cast(builtins.str, jsii.get(self, "templateName"))
10825
10828
 
10826
10829
  @template_name.setter
@@ -11450,7 +11453,7 @@ class CfnPushTemplateProps:
11450
11453
  ) -> None:
11451
11454
  '''Properties for defining a ``CfnPushTemplate``.
11452
11455
 
11453
- :param template_name: The name of the message template.
11456
+ :param template_name: The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
11454
11457
  :param adm: The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
11455
11458
  :param apns: The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
11456
11459
  :param baidu: The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels ( ``Default`` ).
@@ -11558,7 +11561,9 @@ class CfnPushTemplateProps:
11558
11561
 
11559
11562
  @builtins.property
11560
11563
  def template_name(self) -> builtins.str:
11561
- '''The name of the message template.
11564
+ '''The name of the message template to use for the message.
11565
+
11566
+ If specified, this value must match the name of an existing message template.
11562
11567
 
11563
11568
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatename
11564
11569
  '''
@@ -11768,7 +11773,10 @@ class CfnSMSChannel(
11768
11773
  @builtins.property
11769
11774
  @jsii.member(jsii_name="attrId")
11770
11775
  def attr_id(self) -> builtins.str:
11771
- '''
11776
+ '''(Deprecated) An identifier for the SMS channel.
11777
+
11778
+ This property is retained only for backward compatibility.
11779
+
11772
11780
  :cloudformationAttribute: Id
11773
11781
  '''
11774
11782
  return typing.cast(builtins.str, jsii.get(self, "attrId"))
@@ -12116,7 +12124,7 @@ class CfnSegment(
12116
12124
  :param id: Construct identifier for this resource (unique in its scope).
12117
12125
  :param application_id: The unique identifier for the Amazon Pinpoint application that the segment is associated with.
12118
12126
  :param name: The name of the segment. .. epigraph:: A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
12119
- :param dimensions: The criteria that define the dimensions for the segment.
12127
+ :param dimensions: An array that defines the dimensions for the segment.
12120
12128
  :param segment_groups: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
12121
12129
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
12122
12130
  '''
@@ -12224,7 +12232,7 @@ class CfnSegment(
12224
12232
  def dimensions(
12225
12233
  self,
12226
12234
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSegment.SegmentDimensionsProperty"]]:
12227
- '''The criteria that define the dimensions for the segment.'''
12235
+ '''An array that defines the dimensions for the segment.'''
12228
12236
  return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSegment.SegmentDimensionsProperty"]], jsii.get(self, "dimensions"))
12229
12237
 
12230
12238
  @dimensions.setter
@@ -12280,10 +12288,9 @@ class CfnSegment(
12280
12288
  attribute_type: typing.Optional[builtins.str] = None,
12281
12289
  values: typing.Optional[typing.Sequence[builtins.str]] = None,
12282
12290
  ) -> None:
12283
- '''Specifies attribute-based criteria for including or excluding endpoints from a segment.
12284
-
12285
- :param attribute_type: The type of segment dimension to use. Valid values are:. - ``INCLUSIVE`` – endpoints that have attributes matching the values are included in the segment. - ``EXCLUSIVE`` – endpoints that have attributes matching the values are excluded from the segment. - ``CONTAINS`` – endpoints that have attributes' substrings match the values are included in the segment. - ``BEFORE`` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment. - ``AFTER`` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment. - ``BETWEEN`` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment. - ``ON`` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
12286
- :param values: The criteria values to use for the segment dimension. Depending on the value of the ``AttributeType`` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
12291
+ '''
12292
+ :param attribute_type:
12293
+ :param values:
12287
12294
 
12288
12295
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html
12289
12296
  :exampleMetadata: fixture=_generated
@@ -12311,16 +12318,7 @@ class CfnSegment(
12311
12318
 
12312
12319
  @builtins.property
12313
12320
  def attribute_type(self) -> typing.Optional[builtins.str]:
12314
- '''The type of segment dimension to use. Valid values are:.
12315
-
12316
- - ``INCLUSIVE`` – endpoints that have attributes matching the values are included in the segment.
12317
- - ``EXCLUSIVE`` – endpoints that have attributes matching the values are excluded from the segment.
12318
- - ``CONTAINS`` – endpoints that have attributes' substrings match the values are included in the segment.
12319
- - ``BEFORE`` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
12320
- - ``AFTER`` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
12321
- - ``BETWEEN`` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
12322
- - ``ON`` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
12323
-
12321
+ '''
12324
12322
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-attributetype
12325
12323
  '''
12326
12324
  result = self._values.get("attribute_type")
@@ -12328,10 +12326,7 @@ class CfnSegment(
12328
12326
 
12329
12327
  @builtins.property
12330
12328
  def values(self) -> typing.Optional[typing.List[builtins.str]]:
12331
- '''The criteria values to use for the segment dimension.
12332
-
12333
- Depending on the value of the ``AttributeType`` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
12334
-
12329
+ '''
12335
12330
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-values
12336
12331
  '''
12337
12332
  result = self._values.get("values")
@@ -13558,7 +13553,7 @@ class CfnSegmentProps:
13558
13553
 
13559
13554
  :param application_id: The unique identifier for the Amazon Pinpoint application that the segment is associated with.
13560
13555
  :param name: The name of the segment. .. epigraph:: A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
13561
- :param dimensions: The criteria that define the dimensions for the segment.
13556
+ :param dimensions: An array that defines the dimensions for the segment.
13562
13557
  :param segment_groups: The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
13563
13558
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
13564
13559
 
@@ -13743,7 +13738,7 @@ class CfnSegmentProps:
13743
13738
  def dimensions(
13744
13739
  self,
13745
13740
  ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnSegment.SegmentDimensionsProperty]]:
13746
- '''The criteria that define the dimensions for the segment.
13741
+ '''An array that defines the dimensions for the segment.
13747
13742
 
13748
13743
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions
13749
13744
  '''
@@ -13834,7 +13829,7 @@ class CfnSmsTemplate(
13834
13829
  :param scope: Scope in which this resource is defined.
13835
13830
  :param id: Construct identifier for this resource (unique in its scope).
13836
13831
  :param body: The message body to use in text messages that are based on the message template.
13837
- :param template_name: The name of the message template.
13832
+ :param template_name: The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
13838
13833
  :param default_substitutions: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
13839
13834
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
13840
13835
  :param template_description: A custom description of the message template.
@@ -13927,7 +13922,7 @@ class CfnSmsTemplate(
13927
13922
  @builtins.property
13928
13923
  @jsii.member(jsii_name="templateName")
13929
13924
  def template_name(self) -> builtins.str:
13930
- '''The name of the message template.'''
13925
+ '''The name of the message template to use for the message.'''
13931
13926
  return typing.cast(builtins.str, jsii.get(self, "templateName"))
13932
13927
 
13933
13928
  @template_name.setter
@@ -14001,7 +13996,7 @@ class CfnSmsTemplateProps:
14001
13996
  '''Properties for defining a ``CfnSmsTemplate``.
14002
13997
 
14003
13998
  :param body: The message body to use in text messages that are based on the message template.
14004
- :param template_name: The name of the message template.
13999
+ :param template_name: The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
14005
14000
  :param default_substitutions: A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
14006
14001
  :param tags: An array of key-value pairs to apply to this resource. For more information, see `Tag <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html>`_ .
14007
14002
  :param template_description: A custom description of the message template.
@@ -14057,7 +14052,9 @@ class CfnSmsTemplateProps:
14057
14052
 
14058
14053
  @builtins.property
14059
14054
  def template_name(self) -> builtins.str:
14060
- '''The name of the message template.
14055
+ '''The name of the message template to use for the message.
14056
+
14057
+ If specified, this value must match the name of an existing message template.
14061
14058
 
14062
14059
  :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatename
14063
14060
  '''
@@ -14193,7 +14190,10 @@ class CfnVoiceChannel(
14193
14190
  @builtins.property
14194
14191
  @jsii.member(jsii_name="attrId")
14195
14192
  def attr_id(self) -> builtins.str:
14196
- '''
14193
+ '''(Deprecated) An identifier for the voice channel.
14194
+
14195
+ This property is retained only for backward compatibility.
14196
+
14197
14197
  :cloudformationAttribute: Id
14198
14198
  '''
14199
14199
  return typing.cast(builtins.str, jsii.get(self, "attrId"))