aws-cdk-lib 2.182.0__py3-none-any.whl → 2.183.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 +459 -33
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.182.0.jsii.tgz → aws-cdk-lib@2.183.0.jsii.tgz} +0 -0
- aws_cdk/aws_batch/__init__.py +15 -9
- aws_cdk/aws_bedrock/__init__.py +5804 -2325
- aws_cdk/aws_ce/__init__.py +141 -3
- aws_cdk/aws_cloudformation/__init__.py +26 -33
- aws_cdk/aws_cloudtrail/__init__.py +4 -4
- aws_cdk/aws_codebuild/__init__.py +4 -10
- aws_cdk/aws_cognito/__init__.py +3 -3
- aws_cdk/aws_dms/__init__.py +350 -0
- aws_cdk/aws_ec2/__init__.py +63 -5
- aws_cdk/aws_elasticache/__init__.py +3 -3
- aws_cdk/aws_emr/__init__.py +9 -3
- aws_cdk/aws_gameliftstreams/__init__.py +1205 -0
- aws_cdk/aws_iam/__init__.py +290 -35
- aws_cdk/aws_inspector/__init__.py +13 -10
- aws_cdk/aws_iot/__init__.py +616 -22
- aws_cdk/aws_iotfleetwise/__init__.py +72 -10
- aws_cdk/aws_iotsitewise/__init__.py +12 -8
- aws_cdk/aws_kafkaconnect/__init__.py +4 -2
- aws_cdk/aws_lambda/__init__.py +9 -0
- aws_cdk/aws_logs/__init__.py +133 -0
- aws_cdk/aws_medialive/__init__.py +86 -86
- aws_cdk/aws_msk/__init__.py +236 -128
- aws_cdk/aws_neptunegraph/__init__.py +3 -3
- aws_cdk/aws_opensearchserverless/__init__.py +1031 -0
- aws_cdk/aws_quicksight/__init__.py +6511 -20331
- aws_cdk/aws_rds/__init__.py +124 -17
- aws_cdk/aws_redshift/__init__.py +8 -8
- aws_cdk/aws_sagemaker/__init__.py +12 -5
- aws_cdk/aws_securitylake/__init__.py +3 -0
- aws_cdk/aws_synthetics/__init__.py +2 -0
- aws_cdk/aws_transfer/__init__.py +241 -40
- aws_cdk/aws_wafv2/__init__.py +118 -30
- aws_cdk/aws_xray/__init__.py +195 -0
- aws_cdk/custom_resources/__init__.py +65 -8
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/RECORD +43 -42
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.182.0.dist-info → aws_cdk_lib-2.183.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_ce/__init__.py
CHANGED
|
@@ -62,6 +62,8 @@ from .. import (
|
|
|
62
62
|
CfnResource as _CfnResource_9df397a6,
|
|
63
63
|
IInspectable as _IInspectable_c2943556,
|
|
64
64
|
IResolvable as _IResolvable_da3f097b,
|
|
65
|
+
ITaggableV2 as _ITaggableV2_4e6798f8,
|
|
66
|
+
TagManager as _TagManager_0a598cb3,
|
|
65
67
|
TreeInspector as _TreeInspector_488e0dd5,
|
|
66
68
|
)
|
|
67
69
|
|
|
@@ -1068,7 +1070,7 @@ class CfnAnomalySubscriptionProps:
|
|
|
1068
1070
|
)
|
|
1069
1071
|
|
|
1070
1072
|
|
|
1071
|
-
@jsii.implements(_IInspectable_c2943556)
|
|
1073
|
+
@jsii.implements(_IInspectable_c2943556, _ITaggableV2_4e6798f8)
|
|
1072
1074
|
class CfnCostCategory(
|
|
1073
1075
|
_CfnResource_9df397a6,
|
|
1074
1076
|
metaclass=jsii.JSIIMeta,
|
|
@@ -1095,7 +1097,11 @@ class CfnCostCategory(
|
|
|
1095
1097
|
|
|
1096
1098
|
# the properties below are optional
|
|
1097
1099
|
default_value="defaultValue",
|
|
1098
|
-
split_charge_rules="splitChargeRules"
|
|
1100
|
+
split_charge_rules="splitChargeRules",
|
|
1101
|
+
tags=[ce.CfnCostCategory.ResourceTagProperty(
|
|
1102
|
+
key="key",
|
|
1103
|
+
value="value"
|
|
1104
|
+
)]
|
|
1099
1105
|
)
|
|
1100
1106
|
'''
|
|
1101
1107
|
|
|
@@ -1109,6 +1115,7 @@ class CfnCostCategory(
|
|
|
1109
1115
|
rule_version: builtins.str,
|
|
1110
1116
|
default_value: typing.Optional[builtins.str] = None,
|
|
1111
1117
|
split_charge_rules: typing.Optional[builtins.str] = None,
|
|
1118
|
+
tags: typing.Optional[typing.Sequence[typing.Union["CfnCostCategory.ResourceTagProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1112
1119
|
) -> None:
|
|
1113
1120
|
'''
|
|
1114
1121
|
:param scope: Scope in which this resource is defined.
|
|
@@ -1118,6 +1125,7 @@ class CfnCostCategory(
|
|
|
1118
1125
|
:param rule_version: The rule schema version in this particular Cost Category.
|
|
1119
1126
|
:param default_value: The default value for the cost category.
|
|
1120
1127
|
:param split_charge_rules: The split charge rules that are used to allocate your charges between your Cost Category values.
|
|
1128
|
+
:param tags: Tags to assign to the cost category.
|
|
1121
1129
|
'''
|
|
1122
1130
|
if __debug__:
|
|
1123
1131
|
type_hints = typing.get_type_hints(_typecheckingstub__0d86a2b59e53c629c2de8bd291387500a9799712ca28f9459ef98f5dd619ad1a)
|
|
@@ -1129,6 +1137,7 @@ class CfnCostCategory(
|
|
|
1129
1137
|
rule_version=rule_version,
|
|
1130
1138
|
default_value=default_value,
|
|
1131
1139
|
split_charge_rules=split_charge_rules,
|
|
1140
|
+
tags=tags,
|
|
1132
1141
|
)
|
|
1133
1142
|
|
|
1134
1143
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -1181,6 +1190,12 @@ class CfnCostCategory(
|
|
|
1181
1190
|
'''
|
|
1182
1191
|
return typing.cast(builtins.str, jsii.get(self, "attrEffectiveStart"))
|
|
1183
1192
|
|
|
1193
|
+
@builtins.property
|
|
1194
|
+
@jsii.member(jsii_name="cdkTagManager")
|
|
1195
|
+
def cdk_tag_manager(self) -> _TagManager_0a598cb3:
|
|
1196
|
+
'''Tag Manager which manages the tags for this resource.'''
|
|
1197
|
+
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "cdkTagManager"))
|
|
1198
|
+
|
|
1184
1199
|
@builtins.property
|
|
1185
1200
|
@jsii.member(jsii_name="cfnProperties")
|
|
1186
1201
|
def _cfn_properties(self) -> typing.Mapping[builtins.str, typing.Any]:
|
|
@@ -1251,6 +1266,94 @@ class CfnCostCategory(
|
|
|
1251
1266
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1252
1267
|
jsii.set(self, "splitChargeRules", value) # pyright: ignore[reportArgumentType]
|
|
1253
1268
|
|
|
1269
|
+
@builtins.property
|
|
1270
|
+
@jsii.member(jsii_name="tags")
|
|
1271
|
+
def tags(
|
|
1272
|
+
self,
|
|
1273
|
+
) -> typing.Optional[typing.List["CfnCostCategory.ResourceTagProperty"]]:
|
|
1274
|
+
'''Tags to assign to the cost category.'''
|
|
1275
|
+
return typing.cast(typing.Optional[typing.List["CfnCostCategory.ResourceTagProperty"]], jsii.get(self, "tags"))
|
|
1276
|
+
|
|
1277
|
+
@tags.setter
|
|
1278
|
+
def tags(
|
|
1279
|
+
self,
|
|
1280
|
+
value: typing.Optional[typing.List["CfnCostCategory.ResourceTagProperty"]],
|
|
1281
|
+
) -> None:
|
|
1282
|
+
if __debug__:
|
|
1283
|
+
type_hints = typing.get_type_hints(_typecheckingstub__382ee3f151d322b779bace915dc422d549fbc43498f542c3117781ec44cbb469)
|
|
1284
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1285
|
+
jsii.set(self, "tags", value) # pyright: ignore[reportArgumentType]
|
|
1286
|
+
|
|
1287
|
+
@jsii.data_type(
|
|
1288
|
+
jsii_type="aws-cdk-lib.aws_ce.CfnCostCategory.ResourceTagProperty",
|
|
1289
|
+
jsii_struct_bases=[],
|
|
1290
|
+
name_mapping={"key": "key", "value": "value"},
|
|
1291
|
+
)
|
|
1292
|
+
class ResourceTagProperty:
|
|
1293
|
+
def __init__(self, *, key: builtins.str, value: builtins.str) -> None:
|
|
1294
|
+
'''The tag structure that contains a tag key and value.
|
|
1295
|
+
|
|
1296
|
+
.. epigraph::
|
|
1297
|
+
|
|
1298
|
+
Tagging is supported only for the following Cost Explorer resource types: ```AnomalyMonitor`` <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html>`_ , ```AnomalySubscription`` <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html>`_ , ```CostCategory`` <https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html>`_ .
|
|
1299
|
+
|
|
1300
|
+
:param key: The key that's associated with the tag.
|
|
1301
|
+
:param value: The value that's associated with the tag.
|
|
1302
|
+
|
|
1303
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html
|
|
1304
|
+
:exampleMetadata: fixture=_generated
|
|
1305
|
+
|
|
1306
|
+
Example::
|
|
1307
|
+
|
|
1308
|
+
# The code below shows an example of how to instantiate this type.
|
|
1309
|
+
# The values are placeholders you should change.
|
|
1310
|
+
from aws_cdk import aws_ce as ce
|
|
1311
|
+
|
|
1312
|
+
resource_tag_property = ce.CfnCostCategory.ResourceTagProperty(
|
|
1313
|
+
key="key",
|
|
1314
|
+
value="value"
|
|
1315
|
+
)
|
|
1316
|
+
'''
|
|
1317
|
+
if __debug__:
|
|
1318
|
+
type_hints = typing.get_type_hints(_typecheckingstub__8ebb0ce3955d4416c7a704b1a825b845e02eef926e8c0da3592ea7ccecb229d5)
|
|
1319
|
+
check_type(argname="argument key", value=key, expected_type=type_hints["key"])
|
|
1320
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1321
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
1322
|
+
"key": key,
|
|
1323
|
+
"value": value,
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
@builtins.property
|
|
1327
|
+
def key(self) -> builtins.str:
|
|
1328
|
+
'''The key that's associated with the tag.
|
|
1329
|
+
|
|
1330
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html#cfn-ce-costcategory-resourcetag-key
|
|
1331
|
+
'''
|
|
1332
|
+
result = self._values.get("key")
|
|
1333
|
+
assert result is not None, "Required property 'key' is missing"
|
|
1334
|
+
return typing.cast(builtins.str, result)
|
|
1335
|
+
|
|
1336
|
+
@builtins.property
|
|
1337
|
+
def value(self) -> builtins.str:
|
|
1338
|
+
'''The value that's associated with the tag.
|
|
1339
|
+
|
|
1340
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ce-costcategory-resourcetag.html#cfn-ce-costcategory-resourcetag-value
|
|
1341
|
+
'''
|
|
1342
|
+
result = self._values.get("value")
|
|
1343
|
+
assert result is not None, "Required property 'value' is missing"
|
|
1344
|
+
return typing.cast(builtins.str, result)
|
|
1345
|
+
|
|
1346
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
1347
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
1348
|
+
|
|
1349
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
1350
|
+
return not (rhs == self)
|
|
1351
|
+
|
|
1352
|
+
def __repr__(self) -> str:
|
|
1353
|
+
return "ResourceTagProperty(%s)" % ", ".join(
|
|
1354
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
1355
|
+
)
|
|
1356
|
+
|
|
1254
1357
|
|
|
1255
1358
|
@jsii.data_type(
|
|
1256
1359
|
jsii_type="aws-cdk-lib.aws_ce.CfnCostCategoryProps",
|
|
@@ -1261,6 +1364,7 @@ class CfnCostCategory(
|
|
|
1261
1364
|
"rule_version": "ruleVersion",
|
|
1262
1365
|
"default_value": "defaultValue",
|
|
1263
1366
|
"split_charge_rules": "splitChargeRules",
|
|
1367
|
+
"tags": "tags",
|
|
1264
1368
|
},
|
|
1265
1369
|
)
|
|
1266
1370
|
class CfnCostCategoryProps:
|
|
@@ -1272,6 +1376,7 @@ class CfnCostCategoryProps:
|
|
|
1272
1376
|
rule_version: builtins.str,
|
|
1273
1377
|
default_value: typing.Optional[builtins.str] = None,
|
|
1274
1378
|
split_charge_rules: typing.Optional[builtins.str] = None,
|
|
1379
|
+
tags: typing.Optional[typing.Sequence[typing.Union[CfnCostCategory.ResourceTagProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1275
1380
|
) -> None:
|
|
1276
1381
|
'''Properties for defining a ``CfnCostCategory``.
|
|
1277
1382
|
|
|
@@ -1280,6 +1385,7 @@ class CfnCostCategoryProps:
|
|
|
1280
1385
|
:param rule_version: The rule schema version in this particular Cost Category.
|
|
1281
1386
|
:param default_value: The default value for the cost category.
|
|
1282
1387
|
:param split_charge_rules: The split charge rules that are used to allocate your charges between your Cost Category values.
|
|
1388
|
+
:param tags: Tags to assign to the cost category.
|
|
1283
1389
|
|
|
1284
1390
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html
|
|
1285
1391
|
:exampleMetadata: fixture=_generated
|
|
@@ -1297,7 +1403,11 @@ class CfnCostCategoryProps:
|
|
|
1297
1403
|
|
|
1298
1404
|
# the properties below are optional
|
|
1299
1405
|
default_value="defaultValue",
|
|
1300
|
-
split_charge_rules="splitChargeRules"
|
|
1406
|
+
split_charge_rules="splitChargeRules",
|
|
1407
|
+
tags=[ce.CfnCostCategory.ResourceTagProperty(
|
|
1408
|
+
key="key",
|
|
1409
|
+
value="value"
|
|
1410
|
+
)]
|
|
1301
1411
|
)
|
|
1302
1412
|
'''
|
|
1303
1413
|
if __debug__:
|
|
@@ -1307,6 +1417,7 @@ class CfnCostCategoryProps:
|
|
|
1307
1417
|
check_type(argname="argument rule_version", value=rule_version, expected_type=type_hints["rule_version"])
|
|
1308
1418
|
check_type(argname="argument default_value", value=default_value, expected_type=type_hints["default_value"])
|
|
1309
1419
|
check_type(argname="argument split_charge_rules", value=split_charge_rules, expected_type=type_hints["split_charge_rules"])
|
|
1420
|
+
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
1310
1421
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
1311
1422
|
"name": name,
|
|
1312
1423
|
"rules": rules,
|
|
@@ -1316,6 +1427,8 @@ class CfnCostCategoryProps:
|
|
|
1316
1427
|
self._values["default_value"] = default_value
|
|
1317
1428
|
if split_charge_rules is not None:
|
|
1318
1429
|
self._values["split_charge_rules"] = split_charge_rules
|
|
1430
|
+
if tags is not None:
|
|
1431
|
+
self._values["tags"] = tags
|
|
1319
1432
|
|
|
1320
1433
|
@builtins.property
|
|
1321
1434
|
def name(self) -> builtins.str:
|
|
@@ -1369,6 +1482,15 @@ class CfnCostCategoryProps:
|
|
|
1369
1482
|
result = self._values.get("split_charge_rules")
|
|
1370
1483
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
1371
1484
|
|
|
1485
|
+
@builtins.property
|
|
1486
|
+
def tags(self) -> typing.Optional[typing.List[CfnCostCategory.ResourceTagProperty]]:
|
|
1487
|
+
'''Tags to assign to the cost category.
|
|
1488
|
+
|
|
1489
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ce-costcategory.html#cfn-ce-costcategory-tags
|
|
1490
|
+
'''
|
|
1491
|
+
result = self._values.get("tags")
|
|
1492
|
+
return typing.cast(typing.Optional[typing.List[CfnCostCategory.ResourceTagProperty]], result)
|
|
1493
|
+
|
|
1372
1494
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
1373
1495
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
1374
1496
|
|
|
@@ -1574,6 +1696,7 @@ def _typecheckingstub__0d86a2b59e53c629c2de8bd291387500a9799712ca28f9459ef98f5dd
|
|
|
1574
1696
|
rule_version: builtins.str,
|
|
1575
1697
|
default_value: typing.Optional[builtins.str] = None,
|
|
1576
1698
|
split_charge_rules: typing.Optional[builtins.str] = None,
|
|
1699
|
+
tags: typing.Optional[typing.Sequence[typing.Union[CfnCostCategory.ResourceTagProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1577
1700
|
) -> None:
|
|
1578
1701
|
"""Type checking stubs"""
|
|
1579
1702
|
pass
|
|
@@ -1620,6 +1743,20 @@ def _typecheckingstub__ae51b4a5cd7f6e8738ed01709064f1d42c9cdd90e02dfe56151acb934
|
|
|
1620
1743
|
"""Type checking stubs"""
|
|
1621
1744
|
pass
|
|
1622
1745
|
|
|
1746
|
+
def _typecheckingstub__382ee3f151d322b779bace915dc422d549fbc43498f542c3117781ec44cbb469(
|
|
1747
|
+
value: typing.Optional[typing.List[CfnCostCategory.ResourceTagProperty]],
|
|
1748
|
+
) -> None:
|
|
1749
|
+
"""Type checking stubs"""
|
|
1750
|
+
pass
|
|
1751
|
+
|
|
1752
|
+
def _typecheckingstub__8ebb0ce3955d4416c7a704b1a825b845e02eef926e8c0da3592ea7ccecb229d5(
|
|
1753
|
+
*,
|
|
1754
|
+
key: builtins.str,
|
|
1755
|
+
value: builtins.str,
|
|
1756
|
+
) -> None:
|
|
1757
|
+
"""Type checking stubs"""
|
|
1758
|
+
pass
|
|
1759
|
+
|
|
1623
1760
|
def _typecheckingstub__22fe6bbc471c7d1efb8863c64af07f8dbb0f94f407bc64ec8606d11422837dd3(
|
|
1624
1761
|
*,
|
|
1625
1762
|
name: builtins.str,
|
|
@@ -1627,6 +1764,7 @@ def _typecheckingstub__22fe6bbc471c7d1efb8863c64af07f8dbb0f94f407bc64ec8606d1142
|
|
|
1627
1764
|
rule_version: builtins.str,
|
|
1628
1765
|
default_value: typing.Optional[builtins.str] = None,
|
|
1629
1766
|
split_charge_rules: typing.Optional[builtins.str] = None,
|
|
1767
|
+
tags: typing.Optional[typing.Sequence[typing.Union[CfnCostCategory.ResourceTagProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1630
1768
|
) -> None:
|
|
1631
1769
|
"""Type checking stubs"""
|
|
1632
1770
|
pass
|
|
@@ -5533,7 +5533,7 @@ class CfnStack(
|
|
|
5533
5533
|
:param scope: Scope in which this resource is defined.
|
|
5534
5534
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5535
5535
|
:param notification_arns: The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
|
|
5536
|
-
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks.
|
|
5536
|
+
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks. Required if the nested stack requires input parameters. Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
5537
5537
|
:param tags: Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
|
|
5538
5538
|
:param template_url: The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket. The location for an Amazon S3 bucket must start with ``https://`` . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
5539
5539
|
:param timeout_in_minutes: The length of time, in minutes, that CloudFormation waits for the nested stack to reach the ``CREATE_COMPLETE`` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the ``CREATE_COMPLETE`` state, it marks the nested stack resource as ``CREATE_COMPLETE`` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches ``CREATE_COMPLETE`` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. Updates aren't supported.
|
|
@@ -5872,7 +5872,7 @@ class CfnStackProps:
|
|
|
5872
5872
|
'''Properties for defining a ``CfnStack``.
|
|
5873
5873
|
|
|
5874
5874
|
:param notification_arns: The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
|
|
5875
|
-
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks.
|
|
5875
|
+
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks. Required if the nested stack requires input parameters. Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
5876
5876
|
:param tags: Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
|
|
5877
5877
|
:param template_url: The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket. The location for an Amazon S3 bucket must start with ``https://`` . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
5878
5878
|
:param timeout_in_minutes: The length of time, in minutes, that CloudFormation waits for the nested stack to reach the ``CREATE_COMPLETE`` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the ``CREATE_COMPLETE`` state, it marks the nested stack resource as ``CREATE_COMPLETE`` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches ``CREATE_COMPLETE`` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. Updates aren't supported.
|
|
@@ -5940,7 +5940,7 @@ class CfnStackProps:
|
|
|
5940
5940
|
|
|
5941
5941
|
If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks.
|
|
5942
5942
|
|
|
5943
|
-
|
|
5943
|
+
Required if the nested stack requires input parameters.
|
|
5944
5944
|
|
|
5945
5945
|
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
5946
5946
|
|
|
@@ -6100,13 +6100,13 @@ class CfnStackSet(
|
|
|
6100
6100
|
:param scope: Scope in which this resource is defined.
|
|
6101
6101
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6102
6102
|
:param permission_model: Describes how the IAM roles required for stack set operations are created. - With ``SELF_MANAGED`` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* . - With ``SERVICE_MANAGED`` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see `Activate trusted access for stack sets with AWS Organizations <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html>`_ in the *AWS CloudFormation User Guide* .
|
|
6103
|
-
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
6104
|
-
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* .
|
|
6105
|
-
:param auto_deployment:
|
|
6106
|
-
:param call_as:
|
|
6103
|
+
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
6104
|
+
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* . Valid only if the permissions model is ``SELF_MANAGED`` .
|
|
6105
|
+
:param auto_deployment: Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see `Manage automatic deployments for CloudFormation StackSets that use service-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html>`_ in the *AWS CloudFormation User Guide* . Required if the permissions model is ``SERVICE_MANAGED`` . (Not used with self-managed permissions.)
|
|
6106
|
+
:param call_as: Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, ``SELF`` is specified. Use ``SELF`` for stack sets with self-managed permissions. - To create a stack set with service-managed permissions while signed in to the management account, specify ``SELF`` . - To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify ``DELEGATED_ADMIN`` . Your AWS account must be registered as a delegated admin in the management account. For more information, see `Register a delegated administrator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html>`_ in the *AWS CloudFormation User Guide* . Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. Valid only if the permissions model is ``SERVICE_MANAGED`` .
|
|
6107
6107
|
:param capabilities: The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see `Acknowledging IAM resources in CloudFormation templates <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities>`_ in the *AWS CloudFormation User Guide* .
|
|
6108
|
-
:param description: A description of the stack set.
|
|
6109
|
-
:param execution_role_name: The name of the IAM execution role to use to create the stack set. If you don't specify an execution role, CloudFormation uses the ``AWSCloudFormationStackSetExecutionRole`` role for the stack set operation.
|
|
6108
|
+
:param description: A description of the stack set.
|
|
6109
|
+
:param execution_role_name: The name of the IAM execution role to use to create the stack set. If you don't specify an execution role, CloudFormation uses the ``AWSCloudFormationStackSetExecutionRole`` role for the stack set operation. Valid only if the permissions model is ``SELF_MANAGED`` . *Pattern* : ``[a-zA-Z_0-9+=,.@-]+``
|
|
6110
6110
|
:param managed_execution: Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order. .. epigraph:: If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting. You can't modify your stack set's execution configuration while there are running or queued operations for that stack set. When inactive (default), StackSets performs one operation at a time in request order.
|
|
6111
6111
|
:param operation_preferences: The user-specified preferences for how CloudFormation performs a stack set operation.
|
|
6112
6112
|
:param parameters: The input parameters for the stack set template.
|
|
@@ -6233,7 +6233,7 @@ class CfnStackSet(
|
|
|
6233
6233
|
def auto_deployment(
|
|
6234
6234
|
self,
|
|
6235
6235
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnStackSet.AutoDeploymentProperty"]]:
|
|
6236
|
-
'''
|
|
6236
|
+
'''Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).'''
|
|
6237
6237
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnStackSet.AutoDeploymentProperty"]], jsii.get(self, "autoDeployment"))
|
|
6238
6238
|
|
|
6239
6239
|
@auto_deployment.setter
|
|
@@ -6249,7 +6249,7 @@ class CfnStackSet(
|
|
|
6249
6249
|
@builtins.property
|
|
6250
6250
|
@jsii.member(jsii_name="callAs")
|
|
6251
6251
|
def call_as(self) -> typing.Optional[builtins.str]:
|
|
6252
|
-
'''
|
|
6252
|
+
'''Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.'''
|
|
6253
6253
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "callAs"))
|
|
6254
6254
|
|
|
6255
6255
|
@call_as.setter
|
|
@@ -7082,13 +7082,13 @@ class CfnStackSetProps:
|
|
|
7082
7082
|
'''Properties for defining a ``CfnStackSet``.
|
|
7083
7083
|
|
|
7084
7084
|
:param permission_model: Describes how the IAM roles required for stack set operations are created. - With ``SELF_MANAGED`` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* . - With ``SERVICE_MANAGED`` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see `Activate trusted access for stack sets with AWS Organizations <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html>`_ in the *AWS CloudFormation User Guide* .
|
|
7085
|
-
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
7086
|
-
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* .
|
|
7087
|
-
:param auto_deployment:
|
|
7088
|
-
:param call_as:
|
|
7085
|
+
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
7086
|
+
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* . Valid only if the permissions model is ``SELF_MANAGED`` .
|
|
7087
|
+
:param auto_deployment: Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU). For more information, see `Manage automatic deployments for CloudFormation StackSets that use service-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html>`_ in the *AWS CloudFormation User Guide* . Required if the permissions model is ``SERVICE_MANAGED`` . (Not used with self-managed permissions.)
|
|
7088
|
+
:param call_as: Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, ``SELF`` is specified. Use ``SELF`` for stack sets with self-managed permissions. - To create a stack set with service-managed permissions while signed in to the management account, specify ``SELF`` . - To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify ``DELEGATED_ADMIN`` . Your AWS account must be registered as a delegated admin in the management account. For more information, see `Register a delegated administrator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html>`_ in the *AWS CloudFormation User Guide* . Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. Valid only if the permissions model is ``SERVICE_MANAGED`` .
|
|
7089
7089
|
:param capabilities: The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see `Acknowledging IAM resources in CloudFormation templates <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities>`_ in the *AWS CloudFormation User Guide* .
|
|
7090
|
-
:param description: A description of the stack set.
|
|
7091
|
-
:param execution_role_name: The name of the IAM execution role to use to create the stack set. If you don't specify an execution role, CloudFormation uses the ``AWSCloudFormationStackSetExecutionRole`` role for the stack set operation.
|
|
7090
|
+
:param description: A description of the stack set.
|
|
7091
|
+
:param execution_role_name: The name of the IAM execution role to use to create the stack set. If you don't specify an execution role, CloudFormation uses the ``AWSCloudFormationStackSetExecutionRole`` role for the stack set operation. Valid only if the permissions model is ``SELF_MANAGED`` . *Pattern* : ``[a-zA-Z_0-9+=,.@-]+``
|
|
7092
7092
|
:param managed_execution: Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order. .. epigraph:: If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting. You can't modify your stack set's execution configuration while there are running or queued operations for that stack set. When inactive (default), StackSets performs one operation at a time in request order.
|
|
7093
7093
|
:param operation_preferences: The user-specified preferences for how CloudFormation performs a stack set operation.
|
|
7094
7094
|
:param parameters: The input parameters for the stack set template.
|
|
@@ -7225,9 +7225,6 @@ class CfnStackSetProps:
|
|
|
7225
7225
|
'''The name to associate with the stack set.
|
|
7226
7226
|
|
|
7227
7227
|
The name must be unique in the Region where you create your stack set.
|
|
7228
|
-
.. epigraph::
|
|
7229
|
-
|
|
7230
|
-
The ``StackSetName`` property is required.
|
|
7231
7228
|
|
|
7232
7229
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-stacksetname
|
|
7233
7230
|
'''
|
|
@@ -7243,9 +7240,7 @@ class CfnStackSetProps:
|
|
|
7243
7240
|
|
|
7244
7241
|
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Grant self-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ in the *AWS CloudFormation User Guide* .
|
|
7245
7242
|
|
|
7246
|
-
|
|
7247
|
-
|
|
7248
|
-
*Maximum* : ``2048``
|
|
7243
|
+
Valid only if the permissions model is ``SELF_MANAGED`` .
|
|
7249
7244
|
|
|
7250
7245
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-administrationrolearn
|
|
7251
7246
|
'''
|
|
@@ -7256,7 +7251,11 @@ class CfnStackSetProps:
|
|
|
7256
7251
|
def auto_deployment(
|
|
7257
7252
|
self,
|
|
7258
7253
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnStackSet.AutoDeploymentProperty]]:
|
|
7259
|
-
'''
|
|
7254
|
+
'''Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
|
|
7255
|
+
|
|
7256
|
+
For more information, see `Manage automatic deployments for CloudFormation StackSets that use service-managed permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-manage-auto-deployment.html>`_ in the *AWS CloudFormation User Guide* .
|
|
7257
|
+
|
|
7258
|
+
Required if the permissions model is ``SERVICE_MANAGED`` . (Not used with self-managed permissions.)
|
|
7260
7259
|
|
|
7261
7260
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-autodeployment
|
|
7262
7261
|
'''
|
|
@@ -7265,7 +7264,7 @@ class CfnStackSetProps:
|
|
|
7265
7264
|
|
|
7266
7265
|
@builtins.property
|
|
7267
7266
|
def call_as(self) -> typing.Optional[builtins.str]:
|
|
7268
|
-
'''
|
|
7267
|
+
'''Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
|
|
7269
7268
|
|
|
7270
7269
|
By default, ``SELF`` is specified. Use ``SELF`` for stack sets with self-managed permissions.
|
|
7271
7270
|
|
|
@@ -7276,7 +7275,7 @@ class CfnStackSetProps:
|
|
|
7276
7275
|
|
|
7277
7276
|
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
|
|
7278
7277
|
|
|
7279
|
-
|
|
7278
|
+
Valid only if the permissions model is ``SERVICE_MANAGED`` .
|
|
7280
7279
|
|
|
7281
7280
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-callas
|
|
7282
7281
|
'''
|
|
@@ -7298,10 +7297,6 @@ class CfnStackSetProps:
|
|
|
7298
7297
|
def description(self) -> typing.Optional[builtins.str]:
|
|
7299
7298
|
'''A description of the stack set.
|
|
7300
7299
|
|
|
7301
|
-
*Minimum* : ``1``
|
|
7302
|
-
|
|
7303
|
-
*Maximum* : ``1024``
|
|
7304
|
-
|
|
7305
7300
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-description
|
|
7306
7301
|
'''
|
|
7307
7302
|
result = self._values.get("description")
|
|
@@ -7313,9 +7308,7 @@ class CfnStackSetProps:
|
|
|
7313
7308
|
|
|
7314
7309
|
If you don't specify an execution role, CloudFormation uses the ``AWSCloudFormationStackSetExecutionRole`` role for the stack set operation.
|
|
7315
7310
|
|
|
7316
|
-
|
|
7317
|
-
|
|
7318
|
-
*Maximum* : ``64``
|
|
7311
|
+
Valid only if the permissions model is ``SELF_MANAGED`` .
|
|
7319
7312
|
|
|
7320
7313
|
*Pattern* : ``[a-zA-Z_0-9+=,.@-]+``
|
|
7321
7314
|
|
|
@@ -1980,7 +1980,7 @@ class CfnEventDataStore(
|
|
|
1980
1980
|
) -> None:
|
|
1981
1981
|
'''A single selector statement in an advanced event selector.
|
|
1982
1982
|
|
|
1983
|
-
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: - ``cloudtrail.amazonaws.com`` - ``ec2.amazonaws.com`` - ``kms.amazonaws.com`` - ``s3.amazonaws.com`` - ``secretsmanager.amazonaws.com`` - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For information about
|
|
1983
|
+
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: - ``cloudtrail.amazonaws.com`` - ``ec2.amazonaws.com`` - ``kms.amazonaws.com`` - ``s3.amazonaws.com`` - ``secretsmanager.amazonaws.com`` - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* . .. epigraph:: You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs. - *``userIdentity.arn``* - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with ``userIdentity.arn`` . For more information on the userIdentity element, see `CloudTrail userIdentity element <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html>`_ in the *AWS CloudTrail User Guide* . - *``vpcEndpointId``* - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with ``vpcEndpointId`` .
|
|
1984
1984
|
:param ends_with: An operator that includes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
1985
1985
|
:param equal_to: An operator that includes events that match the exact value of the event record field specified as the value of ``Field`` . This is the only valid operator that you can use with the ``readOnly`` , ``eventCategory`` , and ``resources.type`` fields.
|
|
1986
1986
|
:param not_ends_with: An operator that excludes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
@@ -2090,7 +2090,7 @@ class CfnEventDataStore(
|
|
|
2090
2090
|
|
|
2091
2091
|
- *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value.
|
|
2092
2092
|
|
|
2093
|
-
For information about
|
|
2093
|
+
For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* .
|
|
2094
2094
|
.. epigraph::
|
|
2095
2095
|
|
|
2096
2096
|
You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs.
|
|
@@ -3386,7 +3386,7 @@ class CfnTrail(
|
|
|
3386
3386
|
) -> None:
|
|
3387
3387
|
'''A single selector statement in an advanced event selector.
|
|
3388
3388
|
|
|
3389
|
-
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: - ``cloudtrail.amazonaws.com`` - ``ec2.amazonaws.com`` - ``kms.amazonaws.com`` - ``s3.amazonaws.com`` - ``secretsmanager.amazonaws.com`` - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For information about
|
|
3389
|
+
:param field: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the field is used only for selecting events as filtering is not supported. For CloudTrail management events, supported fields include ``eventCategory`` (required), ``eventSource`` , and ``readOnly`` . The following additional fields are available for event data stores: ``eventName`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail data events, supported fields include ``eventCategory`` (required), ``resources.type`` (required), ``eventName`` , ``readOnly`` , and ``resources.ARN`` . The following additional fields are available for event data stores: ``eventSource`` , ``eventType`` , ``sessionCredentialFromConsole`` , and ``userIdentity.arn`` . For CloudTrail network activity events, supported fields include ``eventCategory`` (required), ``eventSource`` (required), ``eventName`` , ``errorCode`` , and ``vpcEndpointId`` . For event data stores for CloudTrail Insights events, AWS Config configuration items, Audit Manager evidence, or events outside of AWS , the only supported field is ``eventCategory`` . .. epigraph:: Selectors don't support the use of wildcards like ``*`` . To match multiple values with a single condition, you may use ``StartsWith`` , ``EndsWith`` , ``NotStartsWith`` , or ``NotEndsWith`` to explicitly match the beginning or end of the event field. - *``readOnly``* - This is an optional field that is only used for management events and data events. This field can be set to ``Equals`` with a value of ``true`` or ``false`` . If you do not add this field, CloudTrail logs both ``read`` and ``write`` events. A value of ``true`` logs only ``read`` events. A value of ``false`` logs only ``write`` events. - *``eventSource``* - This field is only used for management events, data events (for event data stores only), and network activity events. For management events for trails, this is an optional field that can be set to ``NotEquals`` ``kms.amazonaws.com`` to exclude KMS management events, or ``NotEquals`` ``rdsdata.amazonaws.com`` to exclude RDS management events. For management and data events for event data stores, you can use it to include or exclude any event source and can use any operator. For network activity events, this is a required field that only uses the ``Equals`` operator. Set this field to the event source for which you want to log network activity events. If you want to log network activity events for multiple event sources, you must create a separate field selector for each event source. The following are valid values for network activity events: - ``cloudtrail.amazonaws.com`` - ``ec2.amazonaws.com`` - ``kms.amazonaws.com`` - ``s3.amazonaws.com`` - ``secretsmanager.amazonaws.com`` - *``eventName``* - This is an optional field that is only used for data events, management events (for event data stores only), and network activity events. You can use any operator with ``eventName`` . You can use it to filter in or filter out specific events. You can have multiple values for this field, separated by commas. - *``eventCategory``* - This field is required and must be set to ``Equals`` . - For CloudTrail management events, the value must be ``Management`` . - For CloudTrail data events, the value must be ``Data`` . - For CloudTrail network activity events, the value must be ``NetworkActivity`` . The following are used only for event data stores: - For CloudTrail Insights events, the value must be ``Insight`` . - For AWS Config configuration items, the value must be ``ConfigurationItem`` . - For Audit Manager evidence, the value must be ``Evidence`` . - For events outside of AWS , the value must be ``ActivityAuditLog`` . - *``eventType``* - This is an optional field available only for event data stores, which is used to filter management and data events on the event type. For information about available event types, see `CloudTrail record contents <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html#ct-event-type>`_ in the *AWS CloudTrail user guide* . - *``errorCode``* - This field is only used to filter CloudTrail network activity events and is optional. This is the error code to filter on. Currently, the only valid ``errorCode`` is ``VpceAccessDenied`` . ``errorCode`` can only use the ``Equals`` operator. - *``sessionCredentialFromConsole``* - This is an optional field available only for event data stores, which is used to filter management and data events based on whether the events originated from an AWS Management Console session. ``sessionCredentialFromConsole`` can only use the ``Equals`` and ``NotEquals`` operators. - *``resources.type``* - This field is required for CloudTrail data events. ``resources.type`` can only use the ``Equals`` operator. For a list of available resource types for data events, see `Data events <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events>`_ in the *AWS CloudTrail User Guide* . You can have only one ``resources.type`` field per selector. To log events on more than one resource type, add another selector. - *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value. For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* . .. epigraph:: You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs. - *``userIdentity.arn``* - This is an optional field available only for event data stores, which is used to filter management and data events on the userIdentity ARN. You can use any operator with ``userIdentity.arn`` . For more information on the userIdentity element, see `CloudTrail userIdentity element <https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html>`_ in the *AWS CloudTrail User Guide* . - *``vpcEndpointId``* - This field is only used to filter CloudTrail network activity events and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with ``vpcEndpointId`` .
|
|
3390
3390
|
:param ends_with: An operator that includes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
3391
3391
|
:param equal_to: An operator that includes events that match the exact value of the event record field specified as the value of ``Field`` . This is the only valid operator that you can use with the ``readOnly`` , ``eventCategory`` , and ``resources.type`` fields.
|
|
3392
3392
|
:param not_ends_with: An operator that excludes events that match the last few characters of the event record field specified as the value of ``Field`` .
|
|
@@ -3496,7 +3496,7 @@ class CfnTrail(
|
|
|
3496
3496
|
|
|
3497
3497
|
- *``resources.ARN``* - The ``resources.ARN`` is an optional field for data events. You can use any operator with ``resources.ARN`` , but if you use ``Equals`` or ``NotEquals`` , the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, use the ``StartsWith`` operator, and include only the bucket ARN as the matching value.
|
|
3498
3498
|
|
|
3499
|
-
For information about
|
|
3499
|
+
For more information about the ARN formats of data event resources, see `Actions, resources, and condition keys for AWS services <https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html>`_ in the *Service Authorization Reference* .
|
|
3500
3500
|
.. epigraph::
|
|
3501
3501
|
|
|
3502
3502
|
You can't use the ``resources.ARN`` field to filter resource types that do not have ARNs.
|