aws-cdk-lib 2.176.0__py3-none-any.whl → 2.178.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 +106 -62
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.176.0.jsii.tgz → aws-cdk-lib@2.178.0.jsii.tgz} +0 -0
- aws_cdk/aws_amplifyuibuilder/__init__.py +8 -8
- aws_cdk/aws_apigateway/__init__.py +97 -97
- aws_cdk/aws_apigatewayv2/__init__.py +35 -10
- aws_cdk/aws_apigatewayv2_integrations/__init__.py +2 -2
- aws_cdk/aws_appconfig/__init__.py +10 -10
- aws_cdk/aws_appflow/__init__.py +20 -20
- aws_cdk/aws_applicationsignals/__init__.py +8 -8
- aws_cdk/aws_appmesh/__init__.py +8 -8
- aws_cdk/aws_appsync/__init__.py +10387 -7038
- aws_cdk/aws_apptest/__init__.py +4 -4
- aws_cdk/aws_aps/__init__.py +135 -0
- aws_cdk/aws_athena/__init__.py +10 -10
- aws_cdk/aws_backup/__init__.py +14 -14
- aws_cdk/aws_batch/__init__.py +189 -24
- aws_cdk/aws_bcmdataexports/__init__.py +4 -4
- aws_cdk/aws_bedrock/__init__.py +5494 -2518
- aws_cdk/aws_certificatemanager/__init__.py +15 -14
- aws_cdk/aws_chatbot/__init__.py +4 -4
- aws_cdk/aws_cloudformation/__init__.py +22 -18
- aws_cdk/aws_cloudfront/__init__.py +686 -9
- aws_cdk/aws_cloudfront_origins/__init__.py +73 -2
- aws_cdk/aws_cloudtrail/__init__.py +4 -4
- aws_cdk/aws_cloudwatch/__init__.py +53 -53
- aws_cdk/aws_codedeploy/__init__.py +2 -2
- aws_cdk/aws_codepipeline/__init__.py +59 -6
- aws_cdk/aws_codepipeline_actions/__init__.py +2 -2
- aws_cdk/aws_cognito/__init__.py +204 -159
- aws_cdk/aws_connect/__init__.py +4 -4
- aws_cdk/aws_customerprofiles/__init__.py +6 -4
- aws_cdk/aws_databrew/__init__.py +16 -16
- aws_cdk/aws_datasync/__init__.py +14 -11
- aws_cdk/aws_datazone/__init__.py +199 -129
- aws_cdk/aws_dms/__init__.py +4 -4
- aws_cdk/aws_dynamodb/__init__.py +267 -25
- aws_cdk/aws_ec2/__init__.py +1142 -184
- aws_cdk/aws_ecs/__init__.py +767 -124
- aws_cdk/aws_ecs_patterns/__init__.py +49 -0
- aws_cdk/aws_efs/__init__.py +8 -8
- aws_cdk/aws_eks/__init__.py +55 -35
- aws_cdk/aws_elasticache/__init__.py +10 -10
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +47 -18
- aws_cdk/aws_elasticsearch/__init__.py +10 -10
- aws_cdk/aws_emr/__init__.py +16 -16
- aws_cdk/aws_emrserverless/__init__.py +93 -4
- aws_cdk/aws_entityresolution/__init__.py +31 -17
- aws_cdk/aws_events/__init__.py +12 -12
- aws_cdk/aws_fis/__init__.py +16 -16
- aws_cdk/aws_fms/__init__.py +46 -0
- aws_cdk/aws_gamelift/__init__.py +8 -10
- aws_cdk/aws_glue/__init__.py +1326 -7
- aws_cdk/aws_greengrassv2/__init__.py +8 -8
- aws_cdk/aws_guardduty/__init__.py +521 -0
- aws_cdk/aws_healthlake/__init__.py +10 -2
- aws_cdk/aws_iam/__init__.py +8 -0
- aws_cdk/aws_imagebuilder/__init__.py +88 -74
- aws_cdk/aws_iot/__init__.py +40 -40
- aws_cdk/aws_iotanalytics/__init__.py +4 -4
- aws_cdk/aws_iotfleetwise/__init__.py +424 -10
- aws_cdk/aws_iotsitewise/__init__.py +84 -13
- aws_cdk/aws_iottwinmaker/__init__.py +18 -18
- aws_cdk/aws_iotwireless/__init__.py +4 -4
- aws_cdk/aws_kafkaconnect/__init__.py +10 -10
- aws_cdk/aws_kendra/__init__.py +0 -10
- aws_cdk/aws_kinesisanalytics/__init__.py +4 -4
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +4 -4
- aws_cdk/aws_kinesisfirehose/__init__.py +4544 -183
- aws_cdk/aws_kms/__init__.py +11 -10
- aws_cdk/aws_lambda/__init__.py +47 -4
- aws_cdk/aws_lambda_nodejs/__init__.py +24 -5
- aws_cdk/aws_launchwizard/__init__.py +10 -10
- aws_cdk/aws_logs/__init__.py +78 -74
- aws_cdk/aws_mediaconnect/__init__.py +509 -12
- aws_cdk/aws_medialive/__init__.py +16 -16
- aws_cdk/aws_mediatailor/__init__.py +10 -10
- aws_cdk/aws_networkfirewall/__init__.py +12 -12
- aws_cdk/aws_notifications/__init__.py +1927 -0
- aws_cdk/aws_notificationscontacts/__init__.py +593 -0
- aws_cdk/aws_omics/__init__.py +4 -4
- aws_cdk/aws_opensearchservice/__init__.py +10 -10
- aws_cdk/aws_opsworks/__init__.py +58 -58
- aws_cdk/aws_personalize/__init__.py +8 -8
- aws_cdk/aws_pipes/__init__.py +20 -20
- aws_cdk/aws_qbusiness/__init__.py +119 -0
- aws_cdk/aws_quicksight/__init__.py +247 -92
- aws_cdk/aws_rds/__init__.py +37 -37
- aws_cdk/aws_redshift/__init__.py +19 -15
- aws_cdk/aws_resiliencehub/__init__.py +0 -41
- aws_cdk/aws_route53/__init__.py +10 -4
- aws_cdk/aws_route53_targets/__init__.py +15 -15
- aws_cdk/aws_rum/__init__.py +4 -4
- aws_cdk/aws_s3/__init__.py +801 -2
- aws_cdk/aws_s3_notifications/__init__.py +5 -5
- aws_cdk/aws_s3tables/__init__.py +2 -2
- aws_cdk/aws_sagemaker/__init__.py +84 -60
- aws_cdk/aws_sam/__init__.py +48 -48
- aws_cdk/aws_secretsmanager/__init__.py +30 -14
- aws_cdk/aws_securityhub/__init__.py +12 -12
- aws_cdk/aws_sns/__init__.py +137 -12
- aws_cdk/aws_ssm/__init__.py +5 -5
- aws_cdk/aws_ssmquicksetup/__init__.py +10 -10
- aws_cdk/aws_stepfunctions/__init__.py +13207 -4740
- aws_cdk/aws_stepfunctions_tasks/__init__.py +77615 -22817
- aws_cdk/aws_synthetics/__init__.py +109 -36
- aws_cdk/aws_timestream/__init__.py +41 -0
- aws_cdk/aws_transfer/__init__.py +9 -10
- aws_cdk/aws_wafv2/__init__.py +24 -22
- aws_cdk/aws_wisdom/__init__.py +8 -8
- aws_cdk/aws_workspacesweb/__init__.py +60 -60
- aws_cdk/aws_xray/__init__.py +8 -8
- aws_cdk/cloud_assembly_schema/__init__.py +63 -4
- aws_cdk/cx_api/__init__.py +62 -4
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/METADATA +3 -3
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/RECORD +120 -118
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.176.0.dist-info → aws_cdk_lib-2.178.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_sns/__init__.py
CHANGED
|
@@ -351,6 +351,26 @@ topic = sns.Topic(self, "MyTopic",
|
|
|
351
351
|
tracing_config=sns.TracingConfig.ACTIVE
|
|
352
352
|
)
|
|
353
353
|
```
|
|
354
|
+
|
|
355
|
+
## High-throughput mode for Amazon SNS FIFO Topics
|
|
356
|
+
|
|
357
|
+
High throughput FIFO topics in Amazon SNS efficiently manage high message throughput while maintaining strict message order, ensuring reliability and scalability for applications processing numerous messages.
|
|
358
|
+
This solution is ideal for scenarios demanding both high throughput and ordered message delivery.
|
|
359
|
+
|
|
360
|
+
To improve message throughput using high throughput FIFO topics, increasing the number of message groups is recommended.
|
|
361
|
+
|
|
362
|
+
For more information, see [High throughput FIFO topics in Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/fifo-high-throughput.html).
|
|
363
|
+
|
|
364
|
+
You can configure high-throughput mode for your FIFO topics by setting the `fifoThroughputScope` property:
|
|
365
|
+
|
|
366
|
+
```python
|
|
367
|
+
topic = sns.Topic(self, "MyTopic",
|
|
368
|
+
fifo=True,
|
|
369
|
+
fifo_throughput_scope=sns.FifoThroughputScope.TOPIC
|
|
370
|
+
)
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
**Note**: The `fifoThroughputScope` property is only available for FIFO topics.
|
|
354
374
|
'''
|
|
355
375
|
from pkgutil import extend_path
|
|
356
376
|
__path__ = extend_path(__path__, __name__)
|
|
@@ -1126,6 +1146,7 @@ class CfnTopic(
|
|
|
1126
1146
|
success_feedback_sample_rate="successFeedbackSampleRate"
|
|
1127
1147
|
)],
|
|
1128
1148
|
display_name="displayName",
|
|
1149
|
+
fifo_throughput_scope="fifoThroughputScope",
|
|
1129
1150
|
fifo_topic=False,
|
|
1130
1151
|
kms_master_key_id="kmsMasterKeyId",
|
|
1131
1152
|
signature_version="signatureVersion",
|
|
@@ -1152,6 +1173,7 @@ class CfnTopic(
|
|
|
1152
1173
|
data_protection_policy: typing.Any = None,
|
|
1153
1174
|
delivery_status_logging: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTopic.LoggingConfigProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
1154
1175
|
display_name: typing.Optional[builtins.str] = None,
|
|
1176
|
+
fifo_throughput_scope: typing.Optional[builtins.str] = None,
|
|
1155
1177
|
fifo_topic: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
1156
1178
|
kms_master_key_id: typing.Optional[builtins.str] = None,
|
|
1157
1179
|
signature_version: typing.Optional[builtins.str] = None,
|
|
@@ -1168,6 +1190,7 @@ class CfnTopic(
|
|
|
1168
1190
|
:param data_protection_policy: The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720.
|
|
1169
1191
|
:param delivery_status_logging: The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:. - HTTP - Amazon Kinesis Data Firehose - AWS Lambda - Platform application endpoint - Amazon Simple Queue Service Once configured, log entries are sent to Amazon CloudWatch Logs.
|
|
1170
1192
|
:param display_name: The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
|
|
1193
|
+
:param fifo_throughput_scope: Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. Valid values are ``Topic`` or ``MessageGroup`` .
|
|
1171
1194
|
:param fifo_topic: Set to true to create a FIFO topic.
|
|
1172
1195
|
:param kms_master_key_id: The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see `Key terms <https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms>`_ . For more examples, see ``[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)`` in the *AWS Key Management Service API Reference* . This property applies only to `server-side-encryption <https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html>`_ .
|
|
1173
1196
|
:param signature_version: The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1`` .
|
|
@@ -1186,6 +1209,7 @@ class CfnTopic(
|
|
|
1186
1209
|
data_protection_policy=data_protection_policy,
|
|
1187
1210
|
delivery_status_logging=delivery_status_logging,
|
|
1188
1211
|
display_name=display_name,
|
|
1212
|
+
fifo_throughput_scope=fifo_throughput_scope,
|
|
1189
1213
|
fifo_topic=fifo_topic,
|
|
1190
1214
|
kms_master_key_id=kms_master_key_id,
|
|
1191
1215
|
signature_version=signature_version,
|
|
@@ -1331,6 +1355,19 @@ class CfnTopic(
|
|
|
1331
1355
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1332
1356
|
jsii.set(self, "displayName", value) # pyright: ignore[reportArgumentType]
|
|
1333
1357
|
|
|
1358
|
+
@builtins.property
|
|
1359
|
+
@jsii.member(jsii_name="fifoThroughputScope")
|
|
1360
|
+
def fifo_throughput_scope(self) -> typing.Optional[builtins.str]:
|
|
1361
|
+
'''Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.'''
|
|
1362
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "fifoThroughputScope"))
|
|
1363
|
+
|
|
1364
|
+
@fifo_throughput_scope.setter
|
|
1365
|
+
def fifo_throughput_scope(self, value: typing.Optional[builtins.str]) -> None:
|
|
1366
|
+
if __debug__:
|
|
1367
|
+
type_hints = typing.get_type_hints(_typecheckingstub__f138e6ceb99033a1d226873b4907fde5a0fa94382f4183d377b2de329c67e644)
|
|
1368
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
1369
|
+
jsii.set(self, "fifoThroughputScope", value) # pyright: ignore[reportArgumentType]
|
|
1370
|
+
|
|
1334
1371
|
@builtins.property
|
|
1335
1372
|
@jsii.member(jsii_name="fifoTopic")
|
|
1336
1373
|
def fifo_topic(
|
|
@@ -2008,6 +2045,7 @@ class CfnTopicPolicyProps:
|
|
|
2008
2045
|
"data_protection_policy": "dataProtectionPolicy",
|
|
2009
2046
|
"delivery_status_logging": "deliveryStatusLogging",
|
|
2010
2047
|
"display_name": "displayName",
|
|
2048
|
+
"fifo_throughput_scope": "fifoThroughputScope",
|
|
2011
2049
|
"fifo_topic": "fifoTopic",
|
|
2012
2050
|
"kms_master_key_id": "kmsMasterKeyId",
|
|
2013
2051
|
"signature_version": "signatureVersion",
|
|
@@ -2026,6 +2064,7 @@ class CfnTopicProps:
|
|
|
2026
2064
|
data_protection_policy: typing.Any = None,
|
|
2027
2065
|
delivery_status_logging: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnTopic.LoggingConfigProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
2028
2066
|
display_name: typing.Optional[builtins.str] = None,
|
|
2067
|
+
fifo_throughput_scope: typing.Optional[builtins.str] = None,
|
|
2029
2068
|
fifo_topic: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
2030
2069
|
kms_master_key_id: typing.Optional[builtins.str] = None,
|
|
2031
2070
|
signature_version: typing.Optional[builtins.str] = None,
|
|
@@ -2041,6 +2080,7 @@ class CfnTopicProps:
|
|
|
2041
2080
|
:param data_protection_policy: The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720.
|
|
2042
2081
|
:param delivery_status_logging: The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:. - HTTP - Amazon Kinesis Data Firehose - AWS Lambda - Platform application endpoint - Amazon Simple Queue Service Once configured, log entries are sent to Amazon CloudWatch Logs.
|
|
2043
2082
|
:param display_name: The display name to use for an Amazon SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
|
|
2083
|
+
:param fifo_throughput_scope: Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. Valid values are ``Topic`` or ``MessageGroup`` .
|
|
2044
2084
|
:param fifo_topic: Set to true to create a FIFO topic.
|
|
2045
2085
|
:param kms_master_key_id: The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see `Key terms <https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms>`_ . For more examples, see ``[KeyId](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)`` in the *AWS Key Management Service API Reference* . This property applies only to `server-side-encryption <https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html>`_ .
|
|
2046
2086
|
:param signature_version: The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1`` .
|
|
@@ -2074,6 +2114,7 @@ class CfnTopicProps:
|
|
|
2074
2114
|
success_feedback_sample_rate="successFeedbackSampleRate"
|
|
2075
2115
|
)],
|
|
2076
2116
|
display_name="displayName",
|
|
2117
|
+
fifo_throughput_scope="fifoThroughputScope",
|
|
2077
2118
|
fifo_topic=False,
|
|
2078
2119
|
kms_master_key_id="kmsMasterKeyId",
|
|
2079
2120
|
signature_version="signatureVersion",
|
|
@@ -2096,6 +2137,7 @@ class CfnTopicProps:
|
|
|
2096
2137
|
check_type(argname="argument data_protection_policy", value=data_protection_policy, expected_type=type_hints["data_protection_policy"])
|
|
2097
2138
|
check_type(argname="argument delivery_status_logging", value=delivery_status_logging, expected_type=type_hints["delivery_status_logging"])
|
|
2098
2139
|
check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
|
|
2140
|
+
check_type(argname="argument fifo_throughput_scope", value=fifo_throughput_scope, expected_type=type_hints["fifo_throughput_scope"])
|
|
2099
2141
|
check_type(argname="argument fifo_topic", value=fifo_topic, expected_type=type_hints["fifo_topic"])
|
|
2100
2142
|
check_type(argname="argument kms_master_key_id", value=kms_master_key_id, expected_type=type_hints["kms_master_key_id"])
|
|
2101
2143
|
check_type(argname="argument signature_version", value=signature_version, expected_type=type_hints["signature_version"])
|
|
@@ -2114,6 +2156,8 @@ class CfnTopicProps:
|
|
|
2114
2156
|
self._values["delivery_status_logging"] = delivery_status_logging
|
|
2115
2157
|
if display_name is not None:
|
|
2116
2158
|
self._values["display_name"] = display_name
|
|
2159
|
+
if fifo_throughput_scope is not None:
|
|
2160
|
+
self._values["fifo_throughput_scope"] = fifo_throughput_scope
|
|
2117
2161
|
if fifo_topic is not None:
|
|
2118
2162
|
self._values["fifo_topic"] = fifo_topic
|
|
2119
2163
|
if kms_master_key_id is not None:
|
|
@@ -2198,6 +2242,17 @@ class CfnTopicProps:
|
|
|
2198
2242
|
result = self._values.get("display_name")
|
|
2199
2243
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
2200
2244
|
|
|
2245
|
+
@builtins.property
|
|
2246
|
+
def fifo_throughput_scope(self) -> typing.Optional[builtins.str]:
|
|
2247
|
+
'''Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.
|
|
2248
|
+
|
|
2249
|
+
Valid values are ``Topic`` or ``MessageGroup`` .
|
|
2250
|
+
|
|
2251
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html#cfn-sns-topic-fifothroughputscope
|
|
2252
|
+
'''
|
|
2253
|
+
result = self._values.get("fifo_throughput_scope")
|
|
2254
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
2255
|
+
|
|
2201
2256
|
@builtins.property
|
|
2202
2257
|
def fifo_topic(
|
|
2203
2258
|
self,
|
|
@@ -2405,6 +2460,32 @@ class DeliveryPolicy:
|
|
|
2405
2460
|
)
|
|
2406
2461
|
|
|
2407
2462
|
|
|
2463
|
+
@jsii.enum(jsii_type="aws-cdk-lib.aws_sns.FifoThroughputScope")
|
|
2464
|
+
class FifoThroughputScope(enum.Enum):
|
|
2465
|
+
'''The throughput quota and deduplication behavior to apply for the FIFO topic.
|
|
2466
|
+
|
|
2467
|
+
:exampleMetadata: infused
|
|
2468
|
+
|
|
2469
|
+
Example::
|
|
2470
|
+
|
|
2471
|
+
topic = sns.Topic(self, "MyTopic",
|
|
2472
|
+
fifo=True,
|
|
2473
|
+
fifo_throughput_scope=sns.FifoThroughputScope.TOPIC
|
|
2474
|
+
)
|
|
2475
|
+
'''
|
|
2476
|
+
|
|
2477
|
+
TOPIC = "TOPIC"
|
|
2478
|
+
'''Topic scope - Throughput: 3000 messages per second and a bandwidth of 20MB per second.
|
|
2479
|
+
|
|
2480
|
+
- Deduplication: Message deduplication is verified on the entire FIFO topic.
|
|
2481
|
+
'''
|
|
2482
|
+
MESSAGE_GROUP = "MESSAGE_GROUP"
|
|
2483
|
+
'''Message group scope - Throughput: Maximum regional limits.
|
|
2484
|
+
|
|
2485
|
+
- Deduplication: Message deduplication is only verified within a message group.
|
|
2486
|
+
'''
|
|
2487
|
+
|
|
2488
|
+
|
|
2408
2489
|
class FilterOrPolicy(
|
|
2409
2490
|
metaclass=jsii.JSIIAbstractClass,
|
|
2410
2491
|
jsii_type="aws-cdk-lib.aws_sns.FilterOrPolicy",
|
|
@@ -5085,6 +5166,11 @@ class TopicBase(
|
|
|
5085
5166
|
|
|
5086
5167
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
5087
5168
|
|
|
5169
|
+
@jsii.member(jsii_name="addSSLPolicy")
|
|
5170
|
+
def _add_ssl_policy(self) -> None:
|
|
5171
|
+
'''Adds a SSL policy to the topic resource policy.'''
|
|
5172
|
+
return typing.cast(None, jsii.invoke(self, "addSSLPolicy", []))
|
|
5173
|
+
|
|
5088
5174
|
@jsii.member(jsii_name="addSubscription")
|
|
5089
5175
|
def add_subscription(self, topic_subscription: ITopicSubscription) -> Subscription:
|
|
5090
5176
|
'''Subscribe some endpoint to this topic.
|
|
@@ -5104,8 +5190,11 @@ class TopicBase(
|
|
|
5104
5190
|
'''Adds a statement to the IAM resource policy associated with this topic.
|
|
5105
5191
|
|
|
5106
5192
|
If this topic was created in this stack (``new Topic``), a topic policy
|
|
5107
|
-
will be automatically created upon the first call to ``addToResourcePolicy``.
|
|
5108
|
-
|
|
5193
|
+
will be automatically created upon the first call to ``addToResourcePolicy``.
|
|
5194
|
+
However, if ``enforceSSL`` is set to ``true``, the policy has already been created
|
|
5195
|
+
before the first call to this method.
|
|
5196
|
+
|
|
5197
|
+
If the topic is imported (``Topic.import``), then this is a no-op.
|
|
5109
5198
|
|
|
5110
5199
|
:param statement: -
|
|
5111
5200
|
'''
|
|
@@ -5136,6 +5225,11 @@ class TopicBase(
|
|
|
5136
5225
|
'''
|
|
5137
5226
|
return typing.cast(_PolicyStatement_0fe33853, jsii.invoke(self, "createSSLPolicyDocument", []))
|
|
5138
5227
|
|
|
5228
|
+
@jsii.member(jsii_name="createTopicPolicy")
|
|
5229
|
+
def _create_topic_policy(self) -> None:
|
|
5230
|
+
'''Creates a topic policy for this topic.'''
|
|
5231
|
+
return typing.cast(None, jsii.invoke(self, "createTopicPolicy", []))
|
|
5232
|
+
|
|
5139
5233
|
@jsii.member(jsii_name="grantPublish")
|
|
5140
5234
|
def grant_publish(self, grantee: _IGrantable_71c4f5de) -> _Grant_a7ae64f8:
|
|
5141
5235
|
'''Grant topic publishing permissions to the given identity.
|
|
@@ -5903,6 +5997,7 @@ class TopicPolicyProps:
|
|
|
5903
5997
|
"display_name": "displayName",
|
|
5904
5998
|
"enforce_ssl": "enforceSSL",
|
|
5905
5999
|
"fifo": "fifo",
|
|
6000
|
+
"fifo_throughput_scope": "fifoThroughputScope",
|
|
5906
6001
|
"logging_configs": "loggingConfigs",
|
|
5907
6002
|
"master_key": "masterKey",
|
|
5908
6003
|
"message_retention_period_in_days": "messageRetentionPeriodInDays",
|
|
@@ -5919,6 +6014,7 @@ class TopicProps:
|
|
|
5919
6014
|
display_name: typing.Optional[builtins.str] = None,
|
|
5920
6015
|
enforce_ssl: typing.Optional[builtins.bool] = None,
|
|
5921
6016
|
fifo: typing.Optional[builtins.bool] = None,
|
|
6017
|
+
fifo_throughput_scope: typing.Optional[FifoThroughputScope] = None,
|
|
5922
6018
|
logging_configs: typing.Optional[typing.Sequence[typing.Union[LoggingConfig, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5923
6019
|
master_key: typing.Optional[_IKey_5f11635f] = None,
|
|
5924
6020
|
message_retention_period_in_days: typing.Optional[jsii.Number] = None,
|
|
@@ -5932,6 +6028,7 @@ class TopicProps:
|
|
|
5932
6028
|
:param display_name: A developer-defined string that can be used to identify this SNS topic. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. Default: None
|
|
5933
6029
|
:param enforce_ssl: Adds a statement to enforce encryption of data in transit when publishing to the topic. Default: false
|
|
5934
6030
|
:param fifo: Set to true to create a FIFO topic. Default: None
|
|
6031
|
+
:param fifo_throughput_scope: Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. You can only set this property when ``fifo`` is ``true``. Default: undefined - SNS default setting is FifoThroughputScope.TOPIC
|
|
5935
6032
|
:param logging_configs: The list of delivery status logging configurations for the topic. Default: None
|
|
5936
6033
|
:param master_key: A KMS Key, either managed by this CDK app, or imported. Default: None
|
|
5937
6034
|
:param message_retention_period_in_days: The number of days Amazon SNS retains messages. It can only be set for FIFO topics. Default: - do not archive messages
|
|
@@ -5944,7 +6041,8 @@ class TopicProps:
|
|
|
5944
6041
|
Example::
|
|
5945
6042
|
|
|
5946
6043
|
topic = sns.Topic(self, "MyTopic",
|
|
5947
|
-
|
|
6044
|
+
fifo=True,
|
|
6045
|
+
fifo_throughput_scope=sns.FifoThroughputScope.TOPIC
|
|
5948
6046
|
)
|
|
5949
6047
|
'''
|
|
5950
6048
|
if __debug__:
|
|
@@ -5953,6 +6051,7 @@ class TopicProps:
|
|
|
5953
6051
|
check_type(argname="argument display_name", value=display_name, expected_type=type_hints["display_name"])
|
|
5954
6052
|
check_type(argname="argument enforce_ssl", value=enforce_ssl, expected_type=type_hints["enforce_ssl"])
|
|
5955
6053
|
check_type(argname="argument fifo", value=fifo, expected_type=type_hints["fifo"])
|
|
6054
|
+
check_type(argname="argument fifo_throughput_scope", value=fifo_throughput_scope, expected_type=type_hints["fifo_throughput_scope"])
|
|
5956
6055
|
check_type(argname="argument logging_configs", value=logging_configs, expected_type=type_hints["logging_configs"])
|
|
5957
6056
|
check_type(argname="argument master_key", value=master_key, expected_type=type_hints["master_key"])
|
|
5958
6057
|
check_type(argname="argument message_retention_period_in_days", value=message_retention_period_in_days, expected_type=type_hints["message_retention_period_in_days"])
|
|
@@ -5968,6 +6067,8 @@ class TopicProps:
|
|
|
5968
6067
|
self._values["enforce_ssl"] = enforce_ssl
|
|
5969
6068
|
if fifo is not None:
|
|
5970
6069
|
self._values["fifo"] = fifo
|
|
6070
|
+
if fifo_throughput_scope is not None:
|
|
6071
|
+
self._values["fifo_throughput_scope"] = fifo_throughput_scope
|
|
5971
6072
|
if logging_configs is not None:
|
|
5972
6073
|
self._values["logging_configs"] = logging_configs
|
|
5973
6074
|
if master_key is not None:
|
|
@@ -6022,6 +6123,17 @@ class TopicProps:
|
|
|
6022
6123
|
result = self._values.get("fifo")
|
|
6023
6124
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
6024
6125
|
|
|
6126
|
+
@builtins.property
|
|
6127
|
+
def fifo_throughput_scope(self) -> typing.Optional[FifoThroughputScope]:
|
|
6128
|
+
'''Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.
|
|
6129
|
+
|
|
6130
|
+
You can only set this property when ``fifo`` is ``true``.
|
|
6131
|
+
|
|
6132
|
+
:default: undefined - SNS default setting is FifoThroughputScope.TOPIC
|
|
6133
|
+
'''
|
|
6134
|
+
result = self._values.get("fifo_throughput_scope")
|
|
6135
|
+
return typing.cast(typing.Optional[FifoThroughputScope], result)
|
|
6136
|
+
|
|
6025
6137
|
@builtins.property
|
|
6026
6138
|
def logging_configs(self) -> typing.Optional[typing.List[LoggingConfig]]:
|
|
6027
6139
|
'''The list of delivery status logging configurations for the topic.
|
|
@@ -6465,18 +6577,17 @@ class Topic(TopicBase, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_sns.T
|
|
|
6465
6577
|
|
|
6466
6578
|
Example::
|
|
6467
6579
|
|
|
6468
|
-
|
|
6580
|
+
from aws_cdk.aws_kinesisfirehose_alpha import DeliveryStream
|
|
6581
|
+
# stream: DeliveryStream
|
|
6469
6582
|
|
|
6470
6583
|
|
|
6471
|
-
topic = sns.Topic(self, "
|
|
6584
|
+
topic = sns.Topic(self, "Topic")
|
|
6472
6585
|
|
|
6473
|
-
|
|
6474
|
-
|
|
6475
|
-
|
|
6476
|
-
|
|
6477
|
-
|
|
6478
|
-
)
|
|
6479
|
-
]
|
|
6586
|
+
sns.Subscription(self, "Subscription",
|
|
6587
|
+
topic=topic,
|
|
6588
|
+
endpoint=stream.delivery_stream_arn,
|
|
6589
|
+
protocol=sns.SubscriptionProtocol.FIREHOSE,
|
|
6590
|
+
subscription_role_arn="SAMPLE_ARN"
|
|
6480
6591
|
)
|
|
6481
6592
|
'''
|
|
6482
6593
|
|
|
@@ -6489,6 +6600,7 @@ class Topic(TopicBase, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_sns.T
|
|
|
6489
6600
|
display_name: typing.Optional[builtins.str] = None,
|
|
6490
6601
|
enforce_ssl: typing.Optional[builtins.bool] = None,
|
|
6491
6602
|
fifo: typing.Optional[builtins.bool] = None,
|
|
6603
|
+
fifo_throughput_scope: typing.Optional[FifoThroughputScope] = None,
|
|
6492
6604
|
logging_configs: typing.Optional[typing.Sequence[typing.Union[LoggingConfig, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6493
6605
|
master_key: typing.Optional[_IKey_5f11635f] = None,
|
|
6494
6606
|
message_retention_period_in_days: typing.Optional[jsii.Number] = None,
|
|
@@ -6503,6 +6615,7 @@ class Topic(TopicBase, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_sns.T
|
|
|
6503
6615
|
:param display_name: A developer-defined string that can be used to identify this SNS topic. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. Default: None
|
|
6504
6616
|
:param enforce_ssl: Adds a statement to enforce encryption of data in transit when publishing to the topic. Default: false
|
|
6505
6617
|
:param fifo: Set to true to create a FIFO topic. Default: None
|
|
6618
|
+
:param fifo_throughput_scope: Specifies the throughput quota and deduplication behavior to apply for the FIFO topic. You can only set this property when ``fifo`` is ``true``. Default: undefined - SNS default setting is FifoThroughputScope.TOPIC
|
|
6506
6619
|
:param logging_configs: The list of delivery status logging configurations for the topic. Default: None
|
|
6507
6620
|
:param master_key: A KMS Key, either managed by this CDK app, or imported. Default: None
|
|
6508
6621
|
:param message_retention_period_in_days: The number of days Amazon SNS retains messages. It can only be set for FIFO topics. Default: - do not archive messages
|
|
@@ -6519,6 +6632,7 @@ class Topic(TopicBase, metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.aws_sns.T
|
|
|
6519
6632
|
display_name=display_name,
|
|
6520
6633
|
enforce_ssl=enforce_ssl,
|
|
6521
6634
|
fifo=fifo,
|
|
6635
|
+
fifo_throughput_scope=fifo_throughput_scope,
|
|
6522
6636
|
logging_configs=logging_configs,
|
|
6523
6637
|
master_key=master_key,
|
|
6524
6638
|
message_retention_period_in_days=message_retention_period_in_days,
|
|
@@ -6652,6 +6766,7 @@ __all__ = [
|
|
|
6652
6766
|
"CfnTopicPolicyProps",
|
|
6653
6767
|
"CfnTopicProps",
|
|
6654
6768
|
"DeliveryPolicy",
|
|
6769
|
+
"FifoThroughputScope",
|
|
6655
6770
|
"Filter",
|
|
6656
6771
|
"FilterOrPolicy",
|
|
6657
6772
|
"FilterOrPolicyType",
|
|
@@ -6813,6 +6928,7 @@ def _typecheckingstub__3c3e689eaa6b740299fa6db2e53acc51021bc5deb0a8dd6d7bc29e8a3
|
|
|
6813
6928
|
data_protection_policy: typing.Any = None,
|
|
6814
6929
|
delivery_status_logging: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnTopic.LoggingConfigProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
6815
6930
|
display_name: typing.Optional[builtins.str] = None,
|
|
6931
|
+
fifo_throughput_scope: typing.Optional[builtins.str] = None,
|
|
6816
6932
|
fifo_topic: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
6817
6933
|
kms_master_key_id: typing.Optional[builtins.str] = None,
|
|
6818
6934
|
signature_version: typing.Optional[builtins.str] = None,
|
|
@@ -6866,6 +6982,12 @@ def _typecheckingstub__7e672f7b6cfea2a409a715963f8ef1b01848153bb4867f8ad868e0bcb
|
|
|
6866
6982
|
"""Type checking stubs"""
|
|
6867
6983
|
pass
|
|
6868
6984
|
|
|
6985
|
+
def _typecheckingstub__f138e6ceb99033a1d226873b4907fde5a0fa94382f4183d377b2de329c67e644(
|
|
6986
|
+
value: typing.Optional[builtins.str],
|
|
6987
|
+
) -> None:
|
|
6988
|
+
"""Type checking stubs"""
|
|
6989
|
+
pass
|
|
6990
|
+
|
|
6869
6991
|
def _typecheckingstub__2a91ed56c1865e9ea5cd3d8d5ffef0aab07b45ce41c2580607fd141166a194ea(
|
|
6870
6992
|
value: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]],
|
|
6871
6993
|
) -> None:
|
|
@@ -7017,6 +7139,7 @@ def _typecheckingstub__39eaeffb1fed865d99c7cf51cdf720d8471aec20b2163161ef50035fb
|
|
|
7017
7139
|
data_protection_policy: typing.Any = None,
|
|
7018
7140
|
delivery_status_logging: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union[CfnTopic.LoggingConfigProperty, typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
7019
7141
|
display_name: typing.Optional[builtins.str] = None,
|
|
7142
|
+
fifo_throughput_scope: typing.Optional[builtins.str] = None,
|
|
7020
7143
|
fifo_topic: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
7021
7144
|
kms_master_key_id: typing.Optional[builtins.str] = None,
|
|
7022
7145
|
signature_version: typing.Optional[builtins.str] = None,
|
|
@@ -7322,6 +7445,7 @@ def _typecheckingstub__093960c1ab5457cc6797eb4a06c9e8fc74e41d4eaa9d0a17f00fa896d
|
|
|
7322
7445
|
display_name: typing.Optional[builtins.str] = None,
|
|
7323
7446
|
enforce_ssl: typing.Optional[builtins.bool] = None,
|
|
7324
7447
|
fifo: typing.Optional[builtins.bool] = None,
|
|
7448
|
+
fifo_throughput_scope: typing.Optional[FifoThroughputScope] = None,
|
|
7325
7449
|
logging_configs: typing.Optional[typing.Sequence[typing.Union[LoggingConfig, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7326
7450
|
master_key: typing.Optional[_IKey_5f11635f] = None,
|
|
7327
7451
|
message_retention_period_in_days: typing.Optional[jsii.Number] = None,
|
|
@@ -7364,6 +7488,7 @@ def _typecheckingstub__5bf7b7a1001dc600e81a7f1c5015e367dc471dcd727360f62a7eaf6eb
|
|
|
7364
7488
|
display_name: typing.Optional[builtins.str] = None,
|
|
7365
7489
|
enforce_ssl: typing.Optional[builtins.bool] = None,
|
|
7366
7490
|
fifo: typing.Optional[builtins.bool] = None,
|
|
7491
|
+
fifo_throughput_scope: typing.Optional[FifoThroughputScope] = None,
|
|
7367
7492
|
logging_configs: typing.Optional[typing.Sequence[typing.Union[LoggingConfig, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7368
7493
|
master_key: typing.Optional[_IKey_5f11635f] = None,
|
|
7369
7494
|
message_retention_period_in_days: typing.Optional[jsii.Number] = None,
|
aws_cdk/aws_ssm/__init__.py
CHANGED
|
@@ -332,7 +332,7 @@ class CfnAssociation(
|
|
|
332
332
|
:param name: The name of the SSM document that contains the configuration information for the instance. You can specify ``Command`` or ``Automation`` documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format: ``arn:partition:ssm:region:account-id:document/document-name`` For example: ``arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`` For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, ``AWS -ApplyPatchBaseline`` or ``My-Document`` .
|
|
333
333
|
:param apply_only_at_cron_interval: By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
|
|
334
334
|
:param association_name: Specify a descriptive name for the association.
|
|
335
|
-
:param automation_target_parameter_name: Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a
|
|
335
|
+
:param automation_target_parameter_name: Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
|
|
336
336
|
:param calendar_names: The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see `AWS Systems Manager Change Calendar <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar>`_ .
|
|
337
337
|
:param compliance_severity: The severity level that is assigned to the association.
|
|
338
338
|
:param document_version: The version of the SSM document to associate with the target. .. epigraph:: Note the following important information. - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ``default`` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to ``default`` . - ``DocumentVersion`` is not valid for documents owned by AWS , such as ``AWS-RunPatchBaseline`` or ``AWS-UpdateSSMAgent`` . If you specify ``DocumentVersion`` for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).
|
|
@@ -937,7 +937,7 @@ class CfnAssociationProps:
|
|
|
937
937
|
:param name: The name of the SSM document that contains the configuration information for the instance. You can specify ``Command`` or ``Automation`` documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format: ``arn:partition:ssm:region:account-id:document/document-name`` For example: ``arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`` For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, ``AWS -ApplyPatchBaseline`` or ``My-Document`` .
|
|
938
938
|
:param apply_only_at_cron_interval: By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
|
|
939
939
|
:param association_name: Specify a descriptive name for the association.
|
|
940
|
-
:param automation_target_parameter_name: Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a
|
|
940
|
+
:param automation_target_parameter_name: Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
|
|
941
941
|
:param calendar_names: The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see `AWS Systems Manager Change Calendar <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar>`_ .
|
|
942
942
|
:param compliance_severity: The severity level that is assigned to the association.
|
|
943
943
|
:param document_version: The version of the SSM document to associate with the target. .. epigraph:: Note the following important information. - State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ``default`` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to ``default`` . - ``DocumentVersion`` is not valid for documents owned by AWS , such as ``AWS-RunPatchBaseline`` or ``AWS-UpdateSSMAgent`` . If you specify ``DocumentVersion`` for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).
|
|
@@ -1093,7 +1093,7 @@ class CfnAssociationProps:
|
|
|
1093
1093
|
def automation_target_parameter_name(self) -> typing.Optional[builtins.str]:
|
|
1094
1094
|
'''Choose the parameter that will define how your automation will branch out.
|
|
1095
1095
|
|
|
1096
|
-
This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a
|
|
1096
|
+
This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
|
|
1097
1097
|
|
|
1098
1098
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername
|
|
1099
1099
|
'''
|
|
@@ -1285,7 +1285,7 @@ class CfnDocument(
|
|
|
1285
1285
|
):
|
|
1286
1286
|
'''The ``AWS::SSM::Document`` resource creates a Systems Manager (SSM) document in AWS Systems Manager .
|
|
1287
1287
|
|
|
1288
|
-
This document
|
|
1288
|
+
This document defines the actions that Systems Manager performs on your AWS resources.
|
|
1289
1289
|
.. epigraph::
|
|
1290
1290
|
|
|
1291
1291
|
This resource does not support AWS CloudFormation drift detection.
|
|
@@ -7217,7 +7217,7 @@ class CfnResourcePolicy(
|
|
|
7217
7217
|
):
|
|
7218
7218
|
'''Creates or updates a Systems Manager resource policy.
|
|
7219
7219
|
|
|
7220
|
-
A resource policy helps you to define the IAM entity (for example, an AWS account ) that can manage your Systems Manager resources. Currently, ``OpsItemGroup`` is the only resource that supports Systems Manager resource policies. The resource policy for ``OpsItemGroup`` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). OpsCenter is a
|
|
7220
|
+
A resource policy helps you to define the IAM entity (for example, an AWS account ) that can manage your Systems Manager resources. Currently, ``OpsItemGroup`` is the only resource that supports Systems Manager resource policies. The resource policy for ``OpsItemGroup`` enables AWS accounts to view and interact with OpsCenter operational work items (OpsItems). OpsCenter is a tool in Systems Manager .
|
|
7221
7221
|
|
|
7222
7222
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcepolicy.html
|
|
7223
7223
|
:cloudformationResource: AWS::SSM::ResourcePolicy
|
|
@@ -307,7 +307,7 @@ class CfnConfigurationManager(
|
|
|
307
307
|
def __init__(
|
|
308
308
|
self,
|
|
309
309
|
*,
|
|
310
|
-
parameters: typing.Union[
|
|
310
|
+
parameters: typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b],
|
|
311
311
|
type: builtins.str,
|
|
312
312
|
id: typing.Optional[builtins.str] = None,
|
|
313
313
|
local_deployment_administration_role_arn: typing.Optional[builtins.str] = None,
|
|
@@ -316,7 +316,7 @@ class CfnConfigurationManager(
|
|
|
316
316
|
) -> None:
|
|
317
317
|
'''The definition of a Quick Setup configuration.
|
|
318
318
|
|
|
319
|
-
:param parameters: The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type. - **AWS Config Recording (Type: AWS QuickSetupType-CFGRecording)** - - ``RecordAllResources`` - Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " ``true`` ". - ``ResourceTypesToRecord`` - Description: (Optional) A comma separated list of resource types you want to record. - ``RecordGlobalResourceTypes`` - Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " ``false`` ". - ``GlobalResourceTypesRegion`` - Description: (Optional) Determines the AWS Region where global resources are recorded. - ``UseCustomBucket`` - Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " ``false`` ". - ``DeliveryBucketName`` - Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to. - ``DeliveryBucketPrefix`` - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket. - ``NotificationOptions`` - Description: (Optional) Determines the notification configuration for the recorder. The valid values are ``NoStreaming`` , ``UseExistingTopic`` , and ``CreateTopic`` . The default value is ``NoStreaming`` . - ``CustomDeliveryTopicAccountId`` - Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the ``UseExistingTopic`` notification option. - ``CustomDeliveryTopicName`` - Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the ``UseExistingTopic`` notification option. - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(7 days)`` , ``rate(1 days)`` , and ``none`` . The default value is " ``none`` ". - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Change Manager (Type: AWS QuickSetupType-SSMChangeMgr)** - - ``DelegatedAccountId`` - Description: (Required) The ID of the delegated administrator account. - ``JobFunction`` - Description: (Required) The name for the Change Manager job function. - ``PermissionType`` - Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are ``CustomPermissions`` and ``AdminPermissions`` . The default value for the parameter is ``CustomerPermissions`` . - ``CustomPermissions`` - Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify ``CustomPermissions`` for the ``PermissionType`` parameter. - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Conformance Packs (Type: AWS QuickSetupType-CFGCPacks)** - - ``DelegatedAccountId`` - Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments. - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(2 days)`` , and ``none`` . The default value is " ``none`` ". - ``CPackNames`` - Description: (Required) A comma separated list of AWS Config conformance packs. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Default Host Management Configuration (Type: AWS QuickSetupType-DHMC)** - - ``UpdateSSMAgent`` - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " ``true`` ". - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru)** - - ``AnalyseAllResources`` - Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " ``false`` ". - ``EnableSnsNotifications`` - Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " ``true`` ". - ``EnableSsmOpsItems`` - Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " ``true`` ". - ``EnableDriftRemediation`` - Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " ``false`` ". - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(1 days)`` , and ``none`` . The default value is " ``none`` ". - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Distributor (Type: AWS QuickSetupType-Distributor)** - - ``PackagesToInstall`` - Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are ``AWSEFSTools`` , ``AWSCWAgent`` , and ``AWSEC2LaunchAgent`` . - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(2 days)`` , and ``none`` . The default value is " ``rate(30 days)`` ". - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Host Management (Type: AWS QuickSetupType-SSMHostMgmt)** - - ``UpdateSSMAgent`` - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " ``true`` ". - ``UpdateEc2LaunchAgent`` - Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " ``false`` ". - ``CollectInventory`` - Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " ``true`` ". - ``ScanInstances`` - Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " ``true`` ". - ``InstallCloudWatchAgent`` - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " ``false`` ". - ``UpdateCloudWatchAgent`` - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " ``false`` ". - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter)** - - ``DelegatedAccountId`` - Description: (Required) The ID of the delegated administrator account. - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Patch Policy (Type: AWS QuickSetupType-PatchPolicy)** - - ``PatchPolicyName`` - Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag. - ``SelectedPatchBaselines`` - Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy. - ``PatchBaselineUseDefault`` - Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided. - ``ConfigurationOptionsPatchOperation`` - Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are ``Scan`` and ``ScanAndInstall`` . The default value for the parameter is ``Scan`` . - ``ConfigurationOptionsScanValue`` - Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches. - ``ConfigurationOptionsInstallValue`` - Description: (Optional) A cron expression that is used as the schedule for when instances install available patches. - ``ConfigurationOptionsScanNextInterval`` - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " ``false`` ". - ``ConfigurationOptionsInstallNextInterval`` - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " ``false`` ". - ``RebootOption`` - Description: (Optional) Determines whether instances are rebooted after patches are installed. Valid values are ``RebootIfNeeded`` and ``NoReboot`` . - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``OutputLogEnableS3`` - Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3. - ``OutputS3Location`` - Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request. - ``OutputS3BucketRegion`` - Description: (Optional) The AWS Region where the Amazon S3 bucket you want to deliver command output to is located. - ``OutputS3BucketName`` - Description: (Optional) The name of the Amazon S3 bucket you want to deliver command output to. - ``OutputS3KeyPrefix`` - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket. - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer)** - - ``SelectedAggregatorRegion`` - Description: (Required) The AWS Region where you want to create the aggregator index. - ``ReplaceExistingAggregator`` - Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the ``SelectedAggregatorRegion`` . - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Resource Scheduler (Type: AWS QuickSetupType-Scheduler)** - - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. - ``ICalendarString`` - Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
|
|
319
|
+
:param parameters: The parameters for the configuration definition type. Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type. - **AWS Config Recording (Type: AWS QuickSetupType-CFGRecording)** - - ``RecordAllResources`` - Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is " ``true`` ". - ``ResourceTypesToRecord`` - Description: (Optional) A comma separated list of resource types you want to record. - ``RecordGlobalResourceTypes`` - Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is " ``false`` ". - ``GlobalResourceTypesRegion`` - Description: (Optional) Determines the AWS Region where global resources are recorded. - ``UseCustomBucket`` - Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is " ``false`` ". - ``DeliveryBucketName`` - Description: (Optional) The name of the Amazon S3 bucket you want AWS Config to deliver configuration snapshots and configuration history files to. - ``DeliveryBucketPrefix`` - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket. - ``NotificationOptions`` - Description: (Optional) Determines the notification configuration for the recorder. The valid values are ``NoStreaming`` , ``UseExistingTopic`` , and ``CreateTopic`` . The default value is ``NoStreaming`` . - ``CustomDeliveryTopicAccountId`` - Description: (Optional) The ID of the AWS account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the ``UseExistingTopic`` notification option. - ``CustomDeliveryTopicName`` - Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the ``UseExistingTopic`` notification option. - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(7 days)`` , ``rate(1 days)`` , and ``none`` . The default value is " ``none`` ". - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Change Manager (Type: AWS QuickSetupType-SSMChangeMgr)** - - ``DelegatedAccountId`` - Description: (Required) The ID of the delegated administrator account. - ``JobFunction`` - Description: (Required) The name for the Change Manager job function. - ``PermissionType`` - Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are ``CustomPermissions`` and ``AdminPermissions`` . The default value for the parameter is ``CustomerPermissions`` . - ``CustomPermissions`` - Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify ``CustomPermissions`` for the ``PermissionType`` parameter. - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Conformance Packs (Type: AWS QuickSetupType-CFGCPacks)** - - ``DelegatedAccountId`` - Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments. - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(2 days)`` , and ``none`` . The default value is " ``none`` ". - ``CPackNames`` - Description: (Required) A comma separated list of AWS Config conformance packs. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Default Host Management Configuration (Type: AWS QuickSetupType-DHMC)** - - ``UpdateSSMAgent`` - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " ``true`` ". - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **DevOps Guru (Type: AWS QuickSetupType-DevOpsGuru)** - - ``AnalyseAllResources`` - Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all AWS CloudFormation stacks in the account. The default value is " ``false`` ". - ``EnableSnsNotifications`` - Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is " ``true`` ". - ``EnableSsmOpsItems`` - Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is " ``true`` ". - ``EnableDriftRemediation`` - Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is " ``false`` ". - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(1 days)`` , and ``none`` . The default value is " ``none`` ". - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Distributor (Type: AWS QuickSetupType-Distributor)** - - ``PackagesToInstall`` - Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are ``AWSEFSTools`` , ``AWSCWAgent`` , and ``AWSEC2LaunchAgent`` . - ``RemediationSchedule`` - Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are ``rate(30 days)`` , ``rate(14 days)`` , ``rate(2 days)`` , and ``none`` . The default value is " ``rate(30 days)`` ". - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Host Management (Type: AWS QuickSetupType-SSMHostMgmt)** - - ``UpdateSSMAgent`` - Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is " ``true`` ". - ``UpdateEc2LaunchAgent`` - Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " ``false`` ". - ``CollectInventory`` - Description: (Optional) A boolean value that determines whether instance metadata is collected on the target instances every 30 minutes. The default value is " ``true`` ". - ``ScanInstances`` - Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " ``true`` ". - ``InstallCloudWatchAgent`` - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is " ``false`` ". - ``UpdateCloudWatchAgent`` - Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is " ``false`` ". - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **OpsCenter (Type: AWS QuickSetupType-SSMOpsCenter)** - - ``DelegatedAccountId`` - Description: (Required) The ID of the delegated administrator account. - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Patch Policy (Type: AWS QuickSetupType-PatchPolicy)** - - ``PatchPolicyName`` - Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag. - ``SelectedPatchBaselines`` - Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy. - ``PatchBaselineUseDefault`` - Description: (Optional) A boolean value that determines whether the selected patch baselines are all AWS provided. - ``ConfigurationOptionsPatchOperation`` - Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are ``Scan`` and ``ScanAndInstall`` . The default value for the parameter is ``Scan`` . - ``ConfigurationOptionsScanValue`` - Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches. - ``ConfigurationOptionsInstallValue`` - Description: (Optional) A cron expression that is used as the schedule for when instances install available patches. - ``ConfigurationOptionsScanNextInterval`` - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " ``false`` ". - ``ConfigurationOptionsInstallNextInterval`` - Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " ``false`` ". - ``RebootOption`` - Description: (Optional) Determines whether instances are rebooted after patches are installed. Valid values are ``RebootIfNeeded`` and ``NoReboot`` . - ``IsPolicyAttachAllowed`` - Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " ``false`` ". - ``OutputLogEnableS3`` - Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3. - ``OutputS3Location`` - Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request. - ``OutputS3BucketRegion`` - Description: (Optional) The AWS Region where the Amazon S3 bucket you want to deliver command output to is located. - ``OutputS3BucketName`` - Description: (Optional) The name of the Amazon S3 bucket you want to deliver command output to. - ``OutputS3KeyPrefix`` - Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket. - ``TargetType`` - Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are ``*`` , ``InstanceIds`` , ``ResourceGroups`` , and ``Tags`` . Use ``*`` to target all instances in the account. - ``TargetInstances`` - Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify ``InstanceIds`` for the ``TargetType`` parameter. - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify ``Tags`` for the ``TargetType`` parameter. - ``ResourceGroupName`` - Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify ``ResourceGroups`` for the ``TargetType`` parameter. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Resource Explorer (Type: AWS QuickSetupType-ResourceExplorer)** - - ``SelectedAggregatorRegion`` - Description: (Required) The AWS Region where you want to create the aggregator index. - ``ReplaceExistingAggregator`` - Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the ``SelectedAggregatorRegion`` . - ``TargetOrganizationalUnits`` - Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to. - **Resource Scheduler (Type: AWS QuickSetupType-Scheduler)** - - ``TargetTagKey`` - Description: (Required) The tag key assigned to the instances you want to target. - ``TargetTagValue`` - Description: (Required) The value of the tag key assigned to the instances you want to target. - ``ICalendarString`` - Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use. - ``TargetAccounts`` - Description: (Optional) The ID of the AWS account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either ``TargetAccounts`` or ``TargetOrganizationalUnits`` . - ``TargetOrganizationalUnits`` - Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. - ``TargetRegions`` - Description: (Required) A comma separated list of AWS Regions you want to deploy the configuration to.
|
|
320
320
|
:param type: The type of the Quick Setup configuration.
|
|
321
321
|
:param id: The ID of the configuration definition.
|
|
322
322
|
:param local_deployment_administration_role_arn: The ARN of the IAM role used to administrate local configuration deployments.
|
|
@@ -369,7 +369,7 @@ class CfnConfigurationManager(
|
|
|
369
369
|
@builtins.property
|
|
370
370
|
def parameters(
|
|
371
371
|
self,
|
|
372
|
-
) -> typing.Union[
|
|
372
|
+
) -> typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]:
|
|
373
373
|
'''The parameters for the configuration definition type.
|
|
374
374
|
|
|
375
375
|
Parameters for configuration definitions vary based the configuration type. The following lists outline the parameters for each configuration type.
|
|
@@ -475,7 +475,7 @@ class CfnConfigurationManager(
|
|
|
475
475
|
- ``UpdateEc2LaunchAgent``
|
|
476
476
|
- Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is " ``false`` ".
|
|
477
477
|
- ``CollectInventory``
|
|
478
|
-
- Description: (Optional) A boolean value that determines whether
|
|
478
|
+
- Description: (Optional) A boolean value that determines whether instance metadata is collected on the target instances every 30 minutes. The default value is " ``true`` ".
|
|
479
479
|
- ``ScanInstances``
|
|
480
480
|
- Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is " ``true`` ".
|
|
481
481
|
- ``InstallCloudWatchAgent``
|
|
@@ -577,7 +577,7 @@ class CfnConfigurationManager(
|
|
|
577
577
|
'''
|
|
578
578
|
result = self._values.get("parameters")
|
|
579
579
|
assert result is not None, "Required property 'parameters' is missing"
|
|
580
|
-
return typing.cast(typing.Union[
|
|
580
|
+
return typing.cast(typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b], result)
|
|
581
581
|
|
|
582
582
|
@builtins.property
|
|
583
583
|
def type(self) -> builtins.str:
|
|
@@ -656,7 +656,7 @@ class CfnConfigurationManager(
|
|
|
656
656
|
last_updated_at: builtins.str,
|
|
657
657
|
status_type: builtins.str,
|
|
658
658
|
status: typing.Optional[builtins.str] = None,
|
|
659
|
-
status_details: typing.Optional[typing.Union[
|
|
659
|
+
status_details: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
660
660
|
status_message: typing.Optional[builtins.str] = None,
|
|
661
661
|
) -> None:
|
|
662
662
|
'''A summarized description of the status.
|
|
@@ -738,13 +738,13 @@ class CfnConfigurationManager(
|
|
|
738
738
|
@builtins.property
|
|
739
739
|
def status_details(
|
|
740
740
|
self,
|
|
741
|
-
) -> typing.Optional[typing.Union[
|
|
741
|
+
) -> typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]]:
|
|
742
742
|
'''Details about the status.
|
|
743
743
|
|
|
744
744
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmquicksetup-configurationmanager-statussummary.html#cfn-ssmquicksetup-configurationmanager-statussummary-statusdetails
|
|
745
745
|
'''
|
|
746
746
|
result = self._values.get("status_details")
|
|
747
|
-
return typing.cast(typing.Optional[typing.Union[
|
|
747
|
+
return typing.cast(typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]], result)
|
|
748
748
|
|
|
749
749
|
@builtins.property
|
|
750
750
|
def status_message(self) -> typing.Optional[builtins.str]:
|
|
@@ -950,7 +950,7 @@ def _typecheckingstub__e616ab12615353ce8adb7959fdd264518ca60136764500b5507fb35dd
|
|
|
950
950
|
|
|
951
951
|
def _typecheckingstub__5de88cdf2c4ba7069e306fade91e021ab2a61a9f9d1bdde1ced8a9f3f54e2741(
|
|
952
952
|
*,
|
|
953
|
-
parameters: typing.Union[
|
|
953
|
+
parameters: typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b],
|
|
954
954
|
type: builtins.str,
|
|
955
955
|
id: typing.Optional[builtins.str] = None,
|
|
956
956
|
local_deployment_administration_role_arn: typing.Optional[builtins.str] = None,
|
|
@@ -965,7 +965,7 @@ def _typecheckingstub__0a15d3717729affa2b751047a4b5b72469d29c10060f85ac60b65e8bc
|
|
|
965
965
|
last_updated_at: builtins.str,
|
|
966
966
|
status_type: builtins.str,
|
|
967
967
|
status: typing.Optional[builtins.str] = None,
|
|
968
|
-
status_details: typing.Optional[typing.Union[
|
|
968
|
+
status_details: typing.Optional[typing.Union[typing.Mapping[builtins.str, builtins.str], _IResolvable_da3f097b]] = None,
|
|
969
969
|
status_message: typing.Optional[builtins.str] = None,
|
|
970
970
|
) -> None:
|
|
971
971
|
"""Type checking stubs"""
|