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.
- aws_cdk/__init__.py +245 -259
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.73.0.jsii.tgz → aws-cdk-lib@2.76.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplifyuibuilder/__init__.py +182 -214
- aws_cdk/aws_apigateway/__init__.py +95 -148
- aws_cdk/aws_appconfig/__init__.py +8 -4
- aws_cdk/aws_appflow/__init__.py +27 -52
- aws_cdk/aws_appmesh/__init__.py +91 -200
- aws_cdk/aws_apprunner/__init__.py +4 -16
- aws_cdk/aws_appstream/__init__.py +18 -82
- aws_cdk/aws_athena/__init__.py +18 -32
- aws_cdk/aws_backup/__init__.py +48 -86
- aws_cdk/aws_batch/__init__.py +9 -2
- aws_cdk/aws_billingconductor/__init__.py +12 -7
- aws_cdk/aws_budgets/__init__.py +8 -17
- aws_cdk/aws_certificatemanager/__init__.py +7 -4
- aws_cdk/aws_cloudfront/__init__.py +14 -11
- aws_cdk/aws_cloudfront_origins/__init__.py +18 -8
- aws_cdk/aws_cloudtrail/__init__.py +7 -14
- aws_cdk/aws_cloudwatch/__init__.py +63 -35
- aws_cdk/aws_codebuild/__init__.py +10 -13
- aws_cdk/aws_codecommit/__init__.py +0 -1
- aws_cdk/aws_codedeploy/__init__.py +165 -162
- aws_cdk/aws_codegurureviewer/__init__.py +4 -4
- aws_cdk/aws_codepipeline/__init__.py +0 -4
- aws_cdk/aws_codepipeline_actions/__init__.py +16 -164
- aws_cdk/aws_cognito/__init__.py +195 -100
- aws_cdk/aws_config/__init__.py +28 -51
- aws_cdk/aws_connectcampaigns/__init__.py +5 -6
- aws_cdk/aws_databrew/__init__.py +5 -6
- aws_cdk/aws_dlm/__init__.py +33 -71
- aws_cdk/aws_docdb/__init__.py +20 -76
- aws_cdk/aws_dynamodb/__init__.py +29 -22
- aws_cdk/aws_ec2/__init__.py +2414 -603
- aws_cdk/aws_ecr/__init__.py +1 -2
- aws_cdk/aws_ecr_assets/__init__.py +27 -14
- aws_cdk/aws_ecs/__init__.py +458 -163
- aws_cdk/aws_ecs_patterns/__init__.py +13 -11
- aws_cdk/aws_eks/__init__.py +13 -8
- aws_cdk/aws_elasticloadbalancing/__init__.py +16 -9
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +142 -82
- aws_cdk/aws_elasticloadbalancingv2_actions/__init__.py +126 -61
- aws_cdk/aws_elasticsearch/__init__.py +0 -7
- aws_cdk/aws_emr/__init__.py +7 -16
- aws_cdk/aws_emrserverless/__init__.py +14 -18
- aws_cdk/aws_events/__init__.py +33 -29
- aws_cdk/aws_events_targets/__init__.py +248 -89
- aws_cdk/aws_frauddetector/__init__.py +3 -4
- aws_cdk/aws_fsx/__init__.py +13 -7
- aws_cdk/aws_gamelift/__init__.py +11 -20
- aws_cdk/aws_grafana/__init__.py +4 -4
- aws_cdk/aws_iam/__init__.py +21 -25
- aws_cdk/aws_imagebuilder/__init__.py +58 -80
- aws_cdk/aws_internetmonitor/__init__.py +18 -10
- aws_cdk/aws_iot/__init__.py +16 -10
- aws_cdk/aws_iotcoredeviceadvisor/__init__.py +16 -26
- aws_cdk/aws_iotevents/__init__.py +6 -4
- aws_cdk/aws_iotfleetwise/__init__.py +27 -40
- aws_cdk/aws_iotsitewise/__init__.py +8 -5
- aws_cdk/aws_iotwireless/__init__.py +14 -9
- aws_cdk/aws_kinesisfirehose/__init__.py +21 -38
- aws_cdk/aws_lambda/__init__.py +76 -53
- aws_cdk/aws_lambda_event_sources/__init__.py +6 -21
- aws_cdk/aws_logs/__init__.py +5 -7
- aws_cdk/aws_macie/__init__.py +28 -23
- aws_cdk/aws_mediaconnect/__init__.py +5 -8
- aws_cdk/aws_mediaconvert/__init__.py +2 -2
- aws_cdk/aws_medialive/__init__.py +2 -4
- aws_cdk/aws_mediapackage/__init__.py +9 -18
- aws_cdk/aws_memorydb/__init__.py +5 -10
- aws_cdk/aws_mwaa/__init__.py +8 -4
- aws_cdk/aws_neptune/__init__.py +4 -4
- aws_cdk/aws_networkfirewall/__init__.py +8 -4
- aws_cdk/aws_networkmanager/__init__.py +4 -4
- aws_cdk/aws_nimblestudio/__init__.py +25 -45
- aws_cdk/aws_opensearchservice/__init__.py +0 -1
- aws_cdk/aws_panorama/__init__.py +11 -12
- aws_cdk/aws_personalize/__init__.py +46 -72
- aws_cdk/aws_pinpoint/__init__.py +36 -65
- aws_cdk/aws_quicksight/__init__.py +9972 -13374
- aws_cdk/aws_rds/__init__.py +53 -22
- aws_cdk/aws_route53/__init__.py +8 -16
- aws_cdk/aws_route53_targets/__init__.py +2 -4
- aws_cdk/aws_s3/__init__.py +41 -90
- aws_cdk/aws_s3_notifications/__init__.py +0 -3
- aws_cdk/aws_sagemaker/__init__.py +16 -10
- aws_cdk/aws_secretsmanager/__init__.py +17 -14
- aws_cdk/aws_servicecatalog/__init__.py +60 -83
- aws_cdk/aws_servicediscovery/__init__.py +4 -6
- aws_cdk/aws_ses/__init__.py +734 -28
- aws_cdk/aws_sns/__init__.py +4 -8
- aws_cdk/aws_ssm/__init__.py +19 -23
- aws_cdk/aws_ssmcontacts/__init__.py +10 -6
- aws_cdk/aws_ssmincidents/__init__.py +2 -1
- aws_cdk/aws_sso/__init__.py +4 -4
- aws_cdk/aws_stepfunctions/__init__.py +6 -15
- aws_cdk/aws_stepfunctions_tasks/__init__.py +51 -24
- aws_cdk/aws_timestream/__init__.py +22 -28
- aws_cdk/aws_transfer/__init__.py +188 -86
- aws_cdk/aws_wafv2/__init__.py +54 -38
- aws_cdk/aws_xray/__init__.py +15 -22
- aws_cdk/cloud_assembly_schema/__init__.py +14 -6
- aws_cdk/custom_resources/__init__.py +2 -3
- aws_cdk/pipelines/__init__.py +104 -134
- aws_cdk/triggers/__init__.py +46 -61
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/METADATA +47 -92
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/RECORD +111 -111
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/top_level.txt +0 -0
|
@@ -287,9 +287,8 @@ class CfnDataset(
|
|
|
287
287
|
*,
|
|
288
288
|
data_location: typing.Optional[builtins.str] = None,
|
|
289
289
|
) -> None:
|
|
290
|
-
'''
|
|
291
|
-
|
|
292
|
-
:param data_location: The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: ``s3://bucket-name/folder-name/``
|
|
290
|
+
'''
|
|
291
|
+
:param data_location: ``CfnDataset.DataSourceProperty.DataLocation``.
|
|
293
292
|
|
|
294
293
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html
|
|
295
294
|
:exampleMetadata: fixture=_generated
|
|
@@ -313,11 +312,7 @@ class CfnDataset(
|
|
|
313
312
|
|
|
314
313
|
@builtins.property
|
|
315
314
|
def data_location(self) -> typing.Optional[builtins.str]:
|
|
316
|
-
'''
|
|
317
|
-
|
|
318
|
-
For example:
|
|
319
|
-
|
|
320
|
-
``s3://bucket-name/folder-name/``
|
|
315
|
+
'''``CfnDataset.DataSourceProperty.DataLocation``.
|
|
321
316
|
|
|
322
317
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-dataset-datasource.html#cfn-personalize-dataset-datasource-datalocation
|
|
323
318
|
'''
|
|
@@ -1513,10 +1508,9 @@ class CfnSolution(
|
|
|
1513
1508
|
metric_name: typing.Optional[builtins.str] = None,
|
|
1514
1509
|
recipe_list: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
1515
1510
|
) -> None:
|
|
1516
|
-
'''
|
|
1517
|
-
|
|
1518
|
-
:param
|
|
1519
|
-
:param recipe_list: The list of candidate recipes.
|
|
1511
|
+
'''
|
|
1512
|
+
:param metric_name: ``CfnSolution.AutoMLConfigProperty.MetricName``.
|
|
1513
|
+
:param recipe_list: ``CfnSolution.AutoMLConfigProperty.RecipeList``.
|
|
1520
1514
|
|
|
1521
1515
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html
|
|
1522
1516
|
:exampleMetadata: fixture=_generated
|
|
@@ -1544,7 +1538,7 @@ class CfnSolution(
|
|
|
1544
1538
|
|
|
1545
1539
|
@builtins.property
|
|
1546
1540
|
def metric_name(self) -> typing.Optional[builtins.str]:
|
|
1547
|
-
'''
|
|
1541
|
+
'''``CfnSolution.AutoMLConfigProperty.MetricName``.
|
|
1548
1542
|
|
|
1549
1543
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-metricname
|
|
1550
1544
|
'''
|
|
@@ -1553,7 +1547,7 @@ class CfnSolution(
|
|
|
1553
1547
|
|
|
1554
1548
|
@builtins.property
|
|
1555
1549
|
def recipe_list(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1556
|
-
'''
|
|
1550
|
+
'''``CfnSolution.AutoMLConfigProperty.RecipeList``.
|
|
1557
1551
|
|
|
1558
1552
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-automlconfig.html#cfn-personalize-solution-automlconfig-recipelist
|
|
1559
1553
|
'''
|
|
@@ -1583,10 +1577,9 @@ class CfnSolution(
|
|
|
1583
1577
|
name: typing.Optional[builtins.str] = None,
|
|
1584
1578
|
values: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
1585
1579
|
) -> None:
|
|
1586
|
-
'''
|
|
1587
|
-
|
|
1588
|
-
:param
|
|
1589
|
-
:param values: A list of the categories for the hyperparameter.
|
|
1580
|
+
'''
|
|
1581
|
+
:param name: ``CfnSolution.CategoricalHyperParameterRangeProperty.Name``.
|
|
1582
|
+
:param values: ``CfnSolution.CategoricalHyperParameterRangeProperty.Values``.
|
|
1590
1583
|
|
|
1591
1584
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html
|
|
1592
1585
|
:exampleMetadata: fixture=_generated
|
|
@@ -1614,7 +1607,7 @@ class CfnSolution(
|
|
|
1614
1607
|
|
|
1615
1608
|
@builtins.property
|
|
1616
1609
|
def name(self) -> typing.Optional[builtins.str]:
|
|
1617
|
-
'''
|
|
1610
|
+
'''``CfnSolution.CategoricalHyperParameterRangeProperty.Name``.
|
|
1618
1611
|
|
|
1619
1612
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-name
|
|
1620
1613
|
'''
|
|
@@ -1623,7 +1616,7 @@ class CfnSolution(
|
|
|
1623
1616
|
|
|
1624
1617
|
@builtins.property
|
|
1625
1618
|
def values(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1626
|
-
'''
|
|
1619
|
+
'''``CfnSolution.CategoricalHyperParameterRangeProperty.Values``.
|
|
1627
1620
|
|
|
1628
1621
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-categoricalhyperparameterrange.html#cfn-personalize-solution-categoricalhyperparameterrange-values
|
|
1629
1622
|
'''
|
|
@@ -1658,11 +1651,10 @@ class CfnSolution(
|
|
|
1658
1651
|
min_value: typing.Optional[jsii.Number] = None,
|
|
1659
1652
|
name: typing.Optional[builtins.str] = None,
|
|
1660
1653
|
) -> None:
|
|
1661
|
-
'''
|
|
1662
|
-
|
|
1663
|
-
:param
|
|
1664
|
-
:param
|
|
1665
|
-
:param name: The name of the hyperparameter.
|
|
1654
|
+
'''
|
|
1655
|
+
:param max_value: ``CfnSolution.ContinuousHyperParameterRangeProperty.MaxValue``.
|
|
1656
|
+
:param min_value: ``CfnSolution.ContinuousHyperParameterRangeProperty.MinValue``.
|
|
1657
|
+
:param name: ``CfnSolution.ContinuousHyperParameterRangeProperty.Name``.
|
|
1666
1658
|
|
|
1667
1659
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html
|
|
1668
1660
|
:exampleMetadata: fixture=_generated
|
|
@@ -1694,7 +1686,7 @@ class CfnSolution(
|
|
|
1694
1686
|
|
|
1695
1687
|
@builtins.property
|
|
1696
1688
|
def max_value(self) -> typing.Optional[jsii.Number]:
|
|
1697
|
-
'''
|
|
1689
|
+
'''``CfnSolution.ContinuousHyperParameterRangeProperty.MaxValue``.
|
|
1698
1690
|
|
|
1699
1691
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-maxvalue
|
|
1700
1692
|
'''
|
|
@@ -1703,7 +1695,7 @@ class CfnSolution(
|
|
|
1703
1695
|
|
|
1704
1696
|
@builtins.property
|
|
1705
1697
|
def min_value(self) -> typing.Optional[jsii.Number]:
|
|
1706
|
-
'''
|
|
1698
|
+
'''``CfnSolution.ContinuousHyperParameterRangeProperty.MinValue``.
|
|
1707
1699
|
|
|
1708
1700
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-minvalue
|
|
1709
1701
|
'''
|
|
@@ -1712,7 +1704,7 @@ class CfnSolution(
|
|
|
1712
1704
|
|
|
1713
1705
|
@builtins.property
|
|
1714
1706
|
def name(self) -> typing.Optional[builtins.str]:
|
|
1715
|
-
'''
|
|
1707
|
+
'''``CfnSolution.ContinuousHyperParameterRangeProperty.Name``.
|
|
1716
1708
|
|
|
1717
1709
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-continuoushyperparameterrange.html#cfn-personalize-solution-continuoushyperparameterrange-name
|
|
1718
1710
|
'''
|
|
@@ -1747,11 +1739,10 @@ class CfnSolution(
|
|
|
1747
1739
|
hpo_objective: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnSolution.HpoObjectiveProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1748
1740
|
hpo_resource_config: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnSolution.HpoResourceConfigProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1749
1741
|
) -> None:
|
|
1750
|
-
'''
|
|
1751
|
-
|
|
1752
|
-
:param
|
|
1753
|
-
:param
|
|
1754
|
-
:param hpo_resource_config: Describes the resource configuration for HPO.
|
|
1742
|
+
'''
|
|
1743
|
+
:param algorithm_hyper_parameter_ranges: ``CfnSolution.HpoConfigProperty.AlgorithmHyperParameterRanges``.
|
|
1744
|
+
:param hpo_objective: ``CfnSolution.HpoConfigProperty.HpoObjective``.
|
|
1745
|
+
:param hpo_resource_config: ``CfnSolution.HpoConfigProperty.HpoResourceConfig``.
|
|
1755
1746
|
|
|
1756
1747
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html
|
|
1757
1748
|
:exampleMetadata: fixture=_generated
|
|
@@ -1807,7 +1798,7 @@ class CfnSolution(
|
|
|
1807
1798
|
def algorithm_hyper_parameter_ranges(
|
|
1808
1799
|
self,
|
|
1809
1800
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSolution.AlgorithmHyperParameterRangesProperty"]]:
|
|
1810
|
-
'''
|
|
1801
|
+
'''``CfnSolution.HpoConfigProperty.AlgorithmHyperParameterRanges``.
|
|
1811
1802
|
|
|
1812
1803
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-algorithmhyperparameterranges
|
|
1813
1804
|
'''
|
|
@@ -1818,11 +1809,7 @@ class CfnSolution(
|
|
|
1818
1809
|
def hpo_objective(
|
|
1819
1810
|
self,
|
|
1820
1811
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSolution.HpoObjectiveProperty"]]:
|
|
1821
|
-
'''
|
|
1822
|
-
|
|
1823
|
-
.. epigraph::
|
|
1824
|
-
|
|
1825
|
-
Amazon Personalize doesn't support configuring the ``hpoObjective`` at this time.
|
|
1812
|
+
'''``CfnSolution.HpoConfigProperty.HpoObjective``.
|
|
1826
1813
|
|
|
1827
1814
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hpoobjective
|
|
1828
1815
|
'''
|
|
@@ -1833,7 +1820,7 @@ class CfnSolution(
|
|
|
1833
1820
|
def hpo_resource_config(
|
|
1834
1821
|
self,
|
|
1835
1822
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnSolution.HpoResourceConfigProperty"]]:
|
|
1836
|
-
'''
|
|
1823
|
+
'''``CfnSolution.HpoConfigProperty.HpoResourceConfig``.
|
|
1837
1824
|
|
|
1838
1825
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoconfig.html#cfn-personalize-solution-hpoconfig-hporesourceconfig
|
|
1839
1826
|
'''
|
|
@@ -1868,15 +1855,10 @@ class CfnSolution(
|
|
|
1868
1855
|
metric_regex: typing.Optional[builtins.str] = None,
|
|
1869
1856
|
type: typing.Optional[builtins.str] = None,
|
|
1870
1857
|
) -> None:
|
|
1871
|
-
'''
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
Amazon Personalize doesn't support configuring the ``hpoObjective`` at this time.
|
|
1876
|
-
|
|
1877
|
-
:param metric_name: The name of the metric.
|
|
1878
|
-
:param metric_regex: A regular expression for finding the metric in the training job logs.
|
|
1879
|
-
:param type: The type of the metric. Valid values are ``Maximize`` and ``Minimize`` .
|
|
1858
|
+
'''
|
|
1859
|
+
:param metric_name: ``CfnSolution.HpoObjectiveProperty.MetricName``.
|
|
1860
|
+
:param metric_regex: ``CfnSolution.HpoObjectiveProperty.MetricRegex``.
|
|
1861
|
+
:param type: ``CfnSolution.HpoObjectiveProperty.Type``.
|
|
1880
1862
|
|
|
1881
1863
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html
|
|
1882
1864
|
:exampleMetadata: fixture=_generated
|
|
@@ -1908,7 +1890,7 @@ class CfnSolution(
|
|
|
1908
1890
|
|
|
1909
1891
|
@builtins.property
|
|
1910
1892
|
def metric_name(self) -> typing.Optional[builtins.str]:
|
|
1911
|
-
'''
|
|
1893
|
+
'''``CfnSolution.HpoObjectiveProperty.MetricName``.
|
|
1912
1894
|
|
|
1913
1895
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricname
|
|
1914
1896
|
'''
|
|
@@ -1917,7 +1899,7 @@ class CfnSolution(
|
|
|
1917
1899
|
|
|
1918
1900
|
@builtins.property
|
|
1919
1901
|
def metric_regex(self) -> typing.Optional[builtins.str]:
|
|
1920
|
-
'''
|
|
1902
|
+
'''``CfnSolution.HpoObjectiveProperty.MetricRegex``.
|
|
1921
1903
|
|
|
1922
1904
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-metricregex
|
|
1923
1905
|
'''
|
|
@@ -1926,9 +1908,7 @@ class CfnSolution(
|
|
|
1926
1908
|
|
|
1927
1909
|
@builtins.property
|
|
1928
1910
|
def type(self) -> typing.Optional[builtins.str]:
|
|
1929
|
-
'''
|
|
1930
|
-
|
|
1931
|
-
Valid values are ``Maximize`` and ``Minimize`` .
|
|
1911
|
+
'''``CfnSolution.HpoObjectiveProperty.Type``.
|
|
1932
1912
|
|
|
1933
1913
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hpoobjective.html#cfn-personalize-solution-hpoobjective-type
|
|
1934
1914
|
'''
|
|
@@ -1961,10 +1941,9 @@ class CfnSolution(
|
|
|
1961
1941
|
max_number_of_training_jobs: typing.Optional[builtins.str] = None,
|
|
1962
1942
|
max_parallel_training_jobs: typing.Optional[builtins.str] = None,
|
|
1963
1943
|
) -> None:
|
|
1964
|
-
'''
|
|
1965
|
-
|
|
1966
|
-
:param
|
|
1967
|
-
:param max_parallel_training_jobs: The maximum number of parallel training jobs when you create a solution version. The maximum value for ``maxParallelTrainingJobs`` is ``10`` .
|
|
1944
|
+
'''
|
|
1945
|
+
:param max_number_of_training_jobs: ``CfnSolution.HpoResourceConfigProperty.MaxNumberOfTrainingJobs``.
|
|
1946
|
+
:param max_parallel_training_jobs: ``CfnSolution.HpoResourceConfigProperty.MaxParallelTrainingJobs``.
|
|
1968
1947
|
|
|
1969
1948
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html
|
|
1970
1949
|
:exampleMetadata: fixture=_generated
|
|
@@ -1992,9 +1971,7 @@ class CfnSolution(
|
|
|
1992
1971
|
|
|
1993
1972
|
@builtins.property
|
|
1994
1973
|
def max_number_of_training_jobs(self) -> typing.Optional[builtins.str]:
|
|
1995
|
-
'''
|
|
1996
|
-
|
|
1997
|
-
The maximum value for ``maxNumberOfTrainingJobs`` is ``40`` .
|
|
1974
|
+
'''``CfnSolution.HpoResourceConfigProperty.MaxNumberOfTrainingJobs``.
|
|
1998
1975
|
|
|
1999
1976
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxnumberoftrainingjobs
|
|
2000
1977
|
'''
|
|
@@ -2003,9 +1980,7 @@ class CfnSolution(
|
|
|
2003
1980
|
|
|
2004
1981
|
@builtins.property
|
|
2005
1982
|
def max_parallel_training_jobs(self) -> typing.Optional[builtins.str]:
|
|
2006
|
-
'''
|
|
2007
|
-
|
|
2008
|
-
The maximum value for ``maxParallelTrainingJobs`` is ``10`` .
|
|
1983
|
+
'''``CfnSolution.HpoResourceConfigProperty.MaxParallelTrainingJobs``.
|
|
2009
1984
|
|
|
2010
1985
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-hporesourceconfig.html#cfn-personalize-solution-hporesourceconfig-maxparalleltrainingjobs
|
|
2011
1986
|
'''
|
|
@@ -2040,11 +2015,10 @@ class CfnSolution(
|
|
|
2040
2015
|
min_value: typing.Optional[jsii.Number] = None,
|
|
2041
2016
|
name: typing.Optional[builtins.str] = None,
|
|
2042
2017
|
) -> None:
|
|
2043
|
-
'''
|
|
2044
|
-
|
|
2045
|
-
:param
|
|
2046
|
-
:param
|
|
2047
|
-
:param name: The name of the hyperparameter.
|
|
2018
|
+
'''
|
|
2019
|
+
:param max_value: ``CfnSolution.IntegerHyperParameterRangeProperty.MaxValue``.
|
|
2020
|
+
:param min_value: ``CfnSolution.IntegerHyperParameterRangeProperty.MinValue``.
|
|
2021
|
+
:param name: ``CfnSolution.IntegerHyperParameterRangeProperty.Name``.
|
|
2048
2022
|
|
|
2049
2023
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html
|
|
2050
2024
|
:exampleMetadata: fixture=_generated
|
|
@@ -2076,7 +2050,7 @@ class CfnSolution(
|
|
|
2076
2050
|
|
|
2077
2051
|
@builtins.property
|
|
2078
2052
|
def max_value(self) -> typing.Optional[jsii.Number]:
|
|
2079
|
-
'''
|
|
2053
|
+
'''``CfnSolution.IntegerHyperParameterRangeProperty.MaxValue``.
|
|
2080
2054
|
|
|
2081
2055
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-maxvalue
|
|
2082
2056
|
'''
|
|
@@ -2085,7 +2059,7 @@ class CfnSolution(
|
|
|
2085
2059
|
|
|
2086
2060
|
@builtins.property
|
|
2087
2061
|
def min_value(self) -> typing.Optional[jsii.Number]:
|
|
2088
|
-
'''
|
|
2062
|
+
'''``CfnSolution.IntegerHyperParameterRangeProperty.MinValue``.
|
|
2089
2063
|
|
|
2090
2064
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-minvalue
|
|
2091
2065
|
'''
|
|
@@ -2094,7 +2068,7 @@ class CfnSolution(
|
|
|
2094
2068
|
|
|
2095
2069
|
@builtins.property
|
|
2096
2070
|
def name(self) -> typing.Optional[builtins.str]:
|
|
2097
|
-
'''
|
|
2071
|
+
'''``CfnSolution.IntegerHyperParameterRangeProperty.Name``.
|
|
2098
2072
|
|
|
2099
2073
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-solution-integerhyperparameterrange.html#cfn-personalize-solution-integerhyperparameterrange-name
|
|
2100
2074
|
'''
|
aws_cdk/aws_pinpoint/__init__.py
CHANGED
|
@@ -3886,7 +3886,7 @@ class CfnCampaign(
|
|
|
3886
3886
|
:param segment_id: The unique identifier for the segment to associate with the campaign.
|
|
3887
3887
|
:param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
|
3888
3888
|
:param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
|
|
3889
|
-
:param custom_delivery_configuration:
|
|
3889
|
+
:param custom_delivery_configuration: ``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
|
|
3890
3890
|
:param description: A custom description of the campaign.
|
|
3891
3891
|
:param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
|
3892
3892
|
: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.
|
|
@@ -3895,7 +3895,7 @@ class CfnCampaign(
|
|
|
3895
3895
|
: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.
|
|
3896
3896
|
:param segment_version: The version of the segment to associate with the campaign.
|
|
3897
3897
|
: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>`_ .
|
|
3898
|
-
:param template_configuration:
|
|
3898
|
+
:param template_configuration: ``AWS::Pinpoint::Campaign.TemplateConfiguration``.
|
|
3899
3899
|
:param treatment_description: A custom description of the default treatment for the campaign.
|
|
3900
3900
|
: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.
|
|
3901
3901
|
'''
|
|
@@ -4106,9 +4106,7 @@ class CfnCampaign(
|
|
|
4106
4106
|
def custom_delivery_configuration(
|
|
4107
4107
|
self,
|
|
4108
4108
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CustomDeliveryConfigurationProperty"]]:
|
|
4109
|
-
'''
|
|
4110
|
-
|
|
4111
|
-
This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
|
|
4109
|
+
'''``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
|
|
4112
4110
|
|
|
4113
4111
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration
|
|
4114
4112
|
'''
|
|
@@ -4260,7 +4258,7 @@ class CfnCampaign(
|
|
|
4260
4258
|
def template_configuration(
|
|
4261
4259
|
self,
|
|
4262
4260
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateConfigurationProperty"]]:
|
|
4263
|
-
'''
|
|
4261
|
+
'''``AWS::Pinpoint::Campaign.TemplateConfiguration``.
|
|
4264
4262
|
|
|
4265
4263
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration
|
|
4266
4264
|
'''
|
|
@@ -4397,9 +4395,8 @@ class CfnCampaign(
|
|
|
4397
4395
|
)
|
|
4398
4396
|
class CampaignCustomMessageProperty:
|
|
4399
4397
|
def __init__(self, *, data: typing.Optional[builtins.str] = None) -> None:
|
|
4400
|
-
'''
|
|
4401
|
-
|
|
4402
|
-
:param data: The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
|
|
4398
|
+
'''
|
|
4399
|
+
:param data: ``CfnCampaign.CampaignCustomMessageProperty.Data``.
|
|
4403
4400
|
|
|
4404
4401
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html
|
|
4405
4402
|
:exampleMetadata: fixture=_generated
|
|
@@ -4423,9 +4420,7 @@ class CfnCampaign(
|
|
|
4423
4420
|
|
|
4424
4421
|
@builtins.property
|
|
4425
4422
|
def data(self) -> typing.Optional[builtins.str]:
|
|
4426
|
-
'''
|
|
4427
|
-
|
|
4428
|
-
The maximum size is 5 KB.
|
|
4423
|
+
'''``CfnCampaign.CampaignCustomMessageProperty.Data``.
|
|
4429
4424
|
|
|
4430
4425
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html#cfn-pinpoint-campaign-campaigncustommessage-data
|
|
4431
4426
|
'''
|
|
@@ -5041,12 +5036,9 @@ class CfnCampaign(
|
|
|
5041
5036
|
delivery_uri: typing.Optional[builtins.str] = None,
|
|
5042
5037
|
endpoint_types: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
5043
5038
|
) -> None:
|
|
5044
|
-
'''
|
|
5045
|
-
|
|
5046
|
-
|
|
5047
|
-
|
|
5048
|
-
:param delivery_uri: The destination to send the campaign or treatment to. This value can be one of the following:. - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. - The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
|
|
5049
|
-
:param endpoint_types: The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ``ChannelType`` property of an endpoint.
|
|
5039
|
+
'''
|
|
5040
|
+
:param delivery_uri: ``CfnCampaign.CustomDeliveryConfigurationProperty.DeliveryUri``.
|
|
5041
|
+
:param endpoint_types: ``CfnCampaign.CustomDeliveryConfigurationProperty.EndpointTypes``.
|
|
5050
5042
|
|
|
5051
5043
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html
|
|
5052
5044
|
:exampleMetadata: fixture=_generated
|
|
@@ -5074,10 +5066,7 @@ class CfnCampaign(
|
|
|
5074
5066
|
|
|
5075
5067
|
@builtins.property
|
|
5076
5068
|
def delivery_uri(self) -> typing.Optional[builtins.str]:
|
|
5077
|
-
'''
|
|
5078
|
-
|
|
5079
|
-
- The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment.
|
|
5080
|
-
- The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
|
|
5069
|
+
'''``CfnCampaign.CustomDeliveryConfigurationProperty.DeliveryUri``.
|
|
5081
5070
|
|
|
5082
5071
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-deliveryuri
|
|
5083
5072
|
'''
|
|
@@ -5086,9 +5075,7 @@ class CfnCampaign(
|
|
|
5086
5075
|
|
|
5087
5076
|
@builtins.property
|
|
5088
5077
|
def endpoint_types(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5089
|
-
'''
|
|
5090
|
-
|
|
5091
|
-
Each valid value maps to a type of channel that you can associate with an endpoint by using the ``ChannelType`` property of an endpoint.
|
|
5078
|
+
'''``CfnCampaign.CustomDeliveryConfigurationProperty.EndpointTypes``.
|
|
5092
5079
|
|
|
5093
5080
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-endpointtypes
|
|
5094
5081
|
'''
|
|
@@ -6023,7 +6010,7 @@ class CfnCampaign(
|
|
|
6023
6010
|
:param adm_message: The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
|
|
6024
6011
|
:param apns_message: The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
|
|
6025
6012
|
:param baidu_message: The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
|
|
6026
|
-
:param custom_message:
|
|
6013
|
+
:param custom_message: ``CfnCampaign.MessageConfigurationProperty.CustomMessage``.
|
|
6027
6014
|
:param default_message: The default message that the campaign sends through all the channels that are configured for the campaign.
|
|
6028
6015
|
:param email_message: The message that the campaign sends through the email channel. If specified, this message overrides the default message.
|
|
6029
6016
|
:param gcm_message: The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
|
|
@@ -6267,9 +6254,7 @@ class CfnCampaign(
|
|
|
6267
6254
|
def custom_message(
|
|
6268
6255
|
self,
|
|
6269
6256
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CampaignCustomMessageProperty"]]:
|
|
6270
|
-
'''
|
|
6271
|
-
|
|
6272
|
-
If specified, this message overrides the default message.
|
|
6257
|
+
'''``CfnCampaign.MessageConfigurationProperty.CustomMessage``.
|
|
6273
6258
|
|
|
6274
6259
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage
|
|
6275
6260
|
'''
|
|
@@ -7101,12 +7086,11 @@ class CfnCampaign(
|
|
|
7101
7086
|
sms_template: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TemplateProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7102
7087
|
voice_template: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnCampaign.TemplateProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7103
7088
|
) -> None:
|
|
7104
|
-
'''
|
|
7105
|
-
|
|
7106
|
-
:param
|
|
7107
|
-
:param
|
|
7108
|
-
:param
|
|
7109
|
-
:param voice_template: The voice template to use for the message. This object isn't supported for campaigns.
|
|
7089
|
+
'''
|
|
7090
|
+
:param email_template: ``CfnCampaign.TemplateConfigurationProperty.EmailTemplate``.
|
|
7091
|
+
:param push_template: ``CfnCampaign.TemplateConfigurationProperty.PushTemplate``.
|
|
7092
|
+
:param sms_template: ``CfnCampaign.TemplateConfigurationProperty.SMSTemplate``.
|
|
7093
|
+
:param voice_template: ``CfnCampaign.TemplateConfigurationProperty.VoiceTemplate``.
|
|
7110
7094
|
|
|
7111
7095
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html
|
|
7112
7096
|
:exampleMetadata: fixture=_generated
|
|
@@ -7156,7 +7140,7 @@ class CfnCampaign(
|
|
|
7156
7140
|
def email_template(
|
|
7157
7141
|
self,
|
|
7158
7142
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
|
|
7159
|
-
'''
|
|
7143
|
+
'''``CfnCampaign.TemplateConfigurationProperty.EmailTemplate``.
|
|
7160
7144
|
|
|
7161
7145
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-emailtemplate
|
|
7162
7146
|
'''
|
|
@@ -7167,7 +7151,7 @@ class CfnCampaign(
|
|
|
7167
7151
|
def push_template(
|
|
7168
7152
|
self,
|
|
7169
7153
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
|
|
7170
|
-
'''
|
|
7154
|
+
'''``CfnCampaign.TemplateConfigurationProperty.PushTemplate``.
|
|
7171
7155
|
|
|
7172
7156
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-pushtemplate
|
|
7173
7157
|
'''
|
|
@@ -7178,7 +7162,7 @@ class CfnCampaign(
|
|
|
7178
7162
|
def sms_template(
|
|
7179
7163
|
self,
|
|
7180
7164
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
|
|
7181
|
-
'''
|
|
7165
|
+
'''``CfnCampaign.TemplateConfigurationProperty.SMSTemplate``.
|
|
7182
7166
|
|
|
7183
7167
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-smstemplate
|
|
7184
7168
|
'''
|
|
@@ -7189,9 +7173,7 @@ class CfnCampaign(
|
|
|
7189
7173
|
def voice_template(
|
|
7190
7174
|
self,
|
|
7191
7175
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateProperty"]]:
|
|
7192
|
-
'''
|
|
7193
|
-
|
|
7194
|
-
This object isn't supported for campaigns.
|
|
7176
|
+
'''``CfnCampaign.TemplateConfigurationProperty.VoiceTemplate``.
|
|
7195
7177
|
|
|
7196
7178
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-voicetemplate
|
|
7197
7179
|
'''
|
|
@@ -7221,10 +7203,9 @@ class CfnCampaign(
|
|
|
7221
7203
|
name: typing.Optional[builtins.str] = None,
|
|
7222
7204
|
version: typing.Optional[builtins.str] = None,
|
|
7223
7205
|
) -> None:
|
|
7224
|
-
'''
|
|
7225
|
-
|
|
7226
|
-
:param
|
|
7227
|
-
:param version: The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the `Template Versions <https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html>`_ resource. If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
|
|
7206
|
+
'''
|
|
7207
|
+
:param name: ``CfnCampaign.TemplateProperty.Name``.
|
|
7208
|
+
:param version: ``CfnCampaign.TemplateProperty.Version``.
|
|
7228
7209
|
|
|
7229
7210
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html
|
|
7230
7211
|
:exampleMetadata: fixture=_generated
|
|
@@ -7252,9 +7233,7 @@ class CfnCampaign(
|
|
|
7252
7233
|
|
|
7253
7234
|
@builtins.property
|
|
7254
7235
|
def name(self) -> typing.Optional[builtins.str]:
|
|
7255
|
-
'''
|
|
7256
|
-
|
|
7257
|
-
If specified, this value must match the name of an existing message template.
|
|
7236
|
+
'''``CfnCampaign.TemplateProperty.Name``.
|
|
7258
7237
|
|
|
7259
7238
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-name
|
|
7260
7239
|
'''
|
|
@@ -7263,11 +7242,7 @@ class CfnCampaign(
|
|
|
7263
7242
|
|
|
7264
7243
|
@builtins.property
|
|
7265
7244
|
def version(self) -> typing.Optional[builtins.str]:
|
|
7266
|
-
'''
|
|
7267
|
-
|
|
7268
|
-
If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the `Template Versions <https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html>`_ resource.
|
|
7269
|
-
|
|
7270
|
-
If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
|
|
7245
|
+
'''``CfnCampaign.TemplateProperty.Version``.
|
|
7271
7246
|
|
|
7272
7247
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-version
|
|
7273
7248
|
'''
|
|
@@ -7314,11 +7289,11 @@ class CfnCampaign(
|
|
|
7314
7289
|
|
|
7315
7290
|
A *treatment* is a variation of a campaign that's used for A/B testing of a campaign.
|
|
7316
7291
|
|
|
7317
|
-
:param custom_delivery_configuration:
|
|
7292
|
+
:param custom_delivery_configuration: ``CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration``.
|
|
7318
7293
|
:param message_configuration: The message configuration settings for the treatment.
|
|
7319
7294
|
:param schedule: The schedule settings for the treatment.
|
|
7320
7295
|
:param size_percent: The allocated percentage of users (segment members) to send the treatment to.
|
|
7321
|
-
:param template_configuration:
|
|
7296
|
+
:param template_configuration: ``CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration``.
|
|
7322
7297
|
:param treatment_description: A custom description of the treatment.
|
|
7323
7298
|
:param treatment_name: A custom name for the treatment.
|
|
7324
7299
|
|
|
@@ -7565,9 +7540,7 @@ class CfnCampaign(
|
|
|
7565
7540
|
def custom_delivery_configuration(
|
|
7566
7541
|
self,
|
|
7567
7542
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.CustomDeliveryConfigurationProperty"]]:
|
|
7568
|
-
'''
|
|
7569
|
-
|
|
7570
|
-
This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
|
|
7543
|
+
'''``CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration``.
|
|
7571
7544
|
|
|
7572
7545
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration
|
|
7573
7546
|
'''
|
|
@@ -7609,7 +7582,7 @@ class CfnCampaign(
|
|
|
7609
7582
|
def template_configuration(
|
|
7610
7583
|
self,
|
|
7611
7584
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnCampaign.TemplateConfigurationProperty"]]:
|
|
7612
|
-
'''
|
|
7585
|
+
'''``CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration``.
|
|
7613
7586
|
|
|
7614
7587
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration
|
|
7615
7588
|
'''
|
|
@@ -7701,7 +7674,7 @@ class CfnCampaignProps:
|
|
|
7701
7674
|
:param segment_id: The unique identifier for the segment to associate with the campaign.
|
|
7702
7675
|
:param additional_treatments: An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
|
7703
7676
|
:param campaign_hook: Specifies the Lambda function to use as a code hook for a campaign.
|
|
7704
|
-
:param custom_delivery_configuration:
|
|
7677
|
+
:param custom_delivery_configuration: ``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
|
|
7705
7678
|
:param description: A custom description of the campaign.
|
|
7706
7679
|
:param holdout_percent: The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
|
7707
7680
|
: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.
|
|
@@ -7710,7 +7683,7 @@ class CfnCampaignProps:
|
|
|
7710
7683
|
: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.
|
|
7711
7684
|
:param segment_version: The version of the segment to associate with the campaign.
|
|
7712
7685
|
: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>`_ .
|
|
7713
|
-
:param template_configuration:
|
|
7686
|
+
:param template_configuration: ``AWS::Pinpoint::Campaign.TemplateConfiguration``.
|
|
7714
7687
|
:param treatment_description: A custom description of the default treatment for the campaign.
|
|
7715
7688
|
: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.
|
|
7716
7689
|
|
|
@@ -8274,9 +8247,7 @@ class CfnCampaignProps:
|
|
|
8274
8247
|
def custom_delivery_configuration(
|
|
8275
8248
|
self,
|
|
8276
8249
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnCampaign.CustomDeliveryConfigurationProperty]]:
|
|
8277
|
-
'''
|
|
8278
|
-
|
|
8279
|
-
This object is required if the ``MessageConfiguration`` object for the treatment specifies a ``CustomMessage`` object.
|
|
8250
|
+
'''``AWS::Pinpoint::Campaign.CustomDeliveryConfiguration``.
|
|
8280
8251
|
|
|
8281
8252
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration
|
|
8282
8253
|
'''
|
|
@@ -8371,7 +8342,7 @@ class CfnCampaignProps:
|
|
|
8371
8342
|
def template_configuration(
|
|
8372
8343
|
self,
|
|
8373
8344
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnCampaign.TemplateConfigurationProperty]]:
|
|
8374
|
-
'''
|
|
8345
|
+
'''``AWS::Pinpoint::Campaign.TemplateConfiguration``.
|
|
8375
8346
|
|
|
8376
8347
|
:link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration
|
|
8377
8348
|
'''
|