aws-cdk-lib 2.117.0__tar.gz → 2.119.0__tar.gz

{aws-cdk-lib-2.117.0 → aws-cdk-lib-2.119.0}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{aws-cdk-lib-2.117.0 → aws-cdk-lib-2.119.0}/NOTICE

@@ -1,5 +1,5 @@
 AWS Cloud Development Kit (AWS CDK)
-Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
 -------------------------------------------------------------------------------
 

{aws-cdk-lib-2.117.0/src/aws_cdk_lib.egg-info → aws-cdk-lib-2.119.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.117.0
+Version: 2.119.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services
@@ -415,7 +415,7 @@ CloudFormation to re-read the secret.
 ## ARN manipulation
 
 Sometimes you will need to put together or pick apart Amazon Resource Names
-(ARNs). The functions `stack.formatArn()` and `stack.parseArn()` exist for
+(ARNs). The functions `stack.formatArn()` and `stack.splitArn()` exist for
 this purpose.
 
 `formatArn()` can be used to build an ARN from components. It will automatically
@@ -429,12 +429,12 @@ use the region and account of the stack you're calling it on:
 stack.format_arn(
     service="lambda",
     resource="function",
-    sep=":",
+    arn_format=ArnFormat.COLON_RESOURCE_NAME,
     resource_name="MyFunction"
 )
 ```
 
-`parseArn()` can be used to get a single component from an ARN. `parseArn()`
+`splitArn()` can be used to get a single component from an ARN. `splitArn()`
 will correctly deal with both literal ARNs and deploy-time values (tokens),
 but in case of a deploy-time value be aware that the result will be another
 deploy-time value which cannot be inspected in the CDK application.
@@ -444,14 +444,13 @@ deploy-time value which cannot be inspected in the CDK application.
 
 
 # Extracts the function name out of an AWS Lambda Function ARN
-arn_components = stack.parse_arn(arn, ":")
+arn_components = stack.split_arn(arn, ArnFormat.COLON_RESOURCE_NAME)
 function_name = arn_components.resource_name
 ```
 
-Note that depending on the service, the resource separator can be either
-`:` or `/`, and the resource name can be either the 6th or 7th
-component in the ARN. When using these functions, you will need to know
-the format of the ARN you are dealing with.
+Note that the format of the resource separator depends on the service and
+may be any of the values supported by `ArnFormat`. When dealing with these
+functions, it is important to know the format of the ARN you are dealing with.
 
 For an exhaustive list of ARN formats used in AWS, see [AWS ARNs and
 Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
@@ -631,7 +630,7 @@ response to the CloudFormation service and handle various error cases.
 Set `serviceToken` to `lambda.functionArn` to use this provider:
 
 ```python
-fn = lambda_.Function(self, "MyProvider", function_props)
+fn = lambda_.SingletonFunction(self, "MyProvider", function_props)
 
 CustomResource(self, "MyResource",
     service_token=fn.function_arn
@@ -645,7 +644,8 @@ framework designed to implement simple and slim custom resource providers. It
 currently only supports Node.js-based user handlers, represents permissions as raw
 JSON blobs instead of `iam.PolicyStatement` objects, and it does not have
 support for asynchronous waiting (handler cannot exceed the 15min lambda
-timeout).
+timeout). The `CustomResourceProviderRuntime` supports runtime `nodejs12.x`,
+`nodejs14.x`, `nodejs16.x`, `nodejs18.x`.
 
 > **As an application builder, we do not recommend you use this provider type.** This provider exists purely for custom resources that are part of the AWS Construct Library.
 >
@@ -1085,6 +1085,31 @@ since the top-level key is an unresolved token. The call to `findInMap` will ret
 region_table.find_in_map(Aws.REGION, "regionName")
 ```
 
+An optional default value can also be passed to `findInMap`. If either key is not found in the map and the mapping is lazy, `findInMap` will return the default value and not render the mapping.
+If the mapping is not lazy or either key is an unresolved token, the call to `findInMap` will return a token that resolves to
+`{ "Fn::FindInMap": [ "MapName", "TopLevelKey", "SecondLevelKey", { "DefaultValue": "DefaultValue" } ] }`, and the mapping will be rendered.
+Note that the `AWS::LanguageExtentions` transform is added to enable the default value functionality.
+
+For example, the following code will again not produce anything in the "Mappings" section. The
+call to `findInMap` will be able to resolve the value during synthesis and simply return
+`'Region not found'`.
+
+```python
+region_table = CfnMapping(self, "RegionTable",
+    mapping={
+        "us-east-1": {
+            "region_name": "US East (N. Virginia)"
+        },
+        "us-east-2": {
+            "region_name": "US East (Ohio)"
+        }
+    },
+    lazy=True
+)
+
+region_table.find_in_map("us-west-1", "regionName", "Region not found")
+```
+
 ### Dynamic References
 
 CloudFormation supports [dynamically resolving](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) values
@@ -1165,6 +1190,13 @@ stack = Stack(app, "StackName",
 )
 ```
 
+You can also set termination protection with the setter after you've instantiated the stack.
+
+```python
+stack = Stack(app, "StackName")
+stack.termination_protection = True
+```
+
 By default, termination protection is disabled.
 
 ### Description
@@ -1223,6 +1255,20 @@ It's possible to synthesize the project with more Resources than the allowed (or
 
 Set the context key `@aws-cdk/core:stackResourceLimit` with the proper value, being 0 for disable the limit of resources.
 
+### Template Indentation
+
+The AWS CloudFormation templates generated by CDK include indentation by default.
+Indentation makes the templates more readable, but also increases their size,
+and CloudFormation templates cannot exceed 1MB.
+
+It's possible to reduce the size of your templates by suppressing indentation.
+
+To do this for all templates, set the context key `@aws-cdk/core:suppressTemplateIndentation` to `true`.
+
+To do this for a specific stack, add a `suppressTemplateIndentation: true` property to the
+stack's `StackProps` parameter. You can also set this property to `false` to override
+the context key setting.
+
 ## App Context
 
 [Context values](https://docs.aws.amazon.com/cdk/v2/guide/context.html) are key-value pairs that can be associated with an app, stack, or construct.
@@ -1416,6 +1462,10 @@ class MyPlugin:
         )
 ```
 
+In addition to the name, plugins may optionally report their version (`version`
+property ) and a list of IDs of the rules they are going to evaluate (`ruleIds`
+property).
+
 Note that plugins are not allowed to modify anything in the cloud assembly. Any
 attempt to do so will result in synthesis failure.
 
@@ -1428,4 +1478,40 @@ add it to the `postinstall`
 [script](https://docs.npmjs.com/cli/v9/using-npm/scripts) in the `package.json`
 file.
 
+## Annotations
+
+Construct authors can add annotations to constructs to report at three different
+levels: `ERROR`, `WARN`, `INFO`.
+
+Typically warnings are added for things that are important for the user to be
+aware of, but will not cause deployment errors in all cases. Some common
+scenarios are (non-exhaustive list):
+
+* Warn when the user needs to take a manual action, e.g. IAM policy should be
+  added to an referenced resource.
+* Warn if the user configuration might not follow best practices (but is still
+  valid)
+* Warn if the user is using a deprecated API
+
+### Acknowledging Warnings
+
+If you would like to run with `--strict` mode enabled (warnings will throw
+errors) it is possible to `acknowledge` warnings to make the warning go away.
+
+For example, if > 10 IAM managed policies are added to an IAM Group, a warning
+will be created:
+
+```text
+IAM:Group:MaxPoliciesExceeded: You added 11 to IAM Group my-group. The maximum number of managed policies attached to an IAM group is 10.
+```
+
+If you have requested a [quota increase](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entities)
+you may have the ability to add > 10 managed policies which means that this
+warning does not apply to you. You can acknowledge this by `acknowledging` the
+warning by the `id`.
+
+```python
+Annotations.of(self).acknowledge_warning("IAM:Group:MaxPoliciesExceeded", "Account has quota increased to 20")
+```
+
 <!--END CORE DOCUMENTATION-->

{aws-cdk-lib-2.117.0 → aws-cdk-lib-2.119.0}/README.md

@@ -391,7 +391,7 @@ CloudFormation to re-read the secret.
 ## ARN manipulation
 
 Sometimes you will need to put together or pick apart Amazon Resource Names
-(ARNs). The functions `stack.formatArn()` and `stack.parseArn()` exist for
+(ARNs). The functions `stack.formatArn()` and `stack.splitArn()` exist for
 this purpose.
 
 `formatArn()` can be used to build an ARN from components. It will automatically
@@ -405,12 +405,12 @@ use the region and account of the stack you're calling it on:
 stack.format_arn(
     service="lambda",
     resource="function",
-    sep=":",
+    arn_format=ArnFormat.COLON_RESOURCE_NAME,
     resource_name="MyFunction"
 )
 ```
 
-`parseArn()` can be used to get a single component from an ARN. `parseArn()`
+`splitArn()` can be used to get a single component from an ARN. `splitArn()`
 will correctly deal with both literal ARNs and deploy-time values (tokens),
 but in case of a deploy-time value be aware that the result will be another
 deploy-time value which cannot be inspected in the CDK application.
@@ -420,14 +420,13 @@ deploy-time value which cannot be inspected in the CDK application.
 
 
 # Extracts the function name out of an AWS Lambda Function ARN
-arn_components = stack.parse_arn(arn, ":")
+arn_components = stack.split_arn(arn, ArnFormat.COLON_RESOURCE_NAME)
 function_name = arn_components.resource_name
 ```
 
-Note that depending on the service, the resource separator can be either
-`:` or `/`, and the resource name can be either the 6th or 7th
-component in the ARN. When using these functions, you will need to know
-the format of the ARN you are dealing with.
+Note that the format of the resource separator depends on the service and
+may be any of the values supported by `ArnFormat`. When dealing with these
+functions, it is important to know the format of the ARN you are dealing with.
 
 For an exhaustive list of ARN formats used in AWS, see [AWS ARNs and
 Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
@@ -607,7 +606,7 @@ response to the CloudFormation service and handle various error cases.
 Set `serviceToken` to `lambda.functionArn` to use this provider:
 
 ```python
-fn = lambda_.Function(self, "MyProvider", function_props)
+fn = lambda_.SingletonFunction(self, "MyProvider", function_props)
 
 CustomResource(self, "MyResource",
     service_token=fn.function_arn
@@ -621,7 +620,8 @@ framework designed to implement simple and slim custom resource providers. It
 currently only supports Node.js-based user handlers, represents permissions as raw
 JSON blobs instead of `iam.PolicyStatement` objects, and it does not have
 support for asynchronous waiting (handler cannot exceed the 15min lambda
-timeout).
+timeout). The `CustomResourceProviderRuntime` supports runtime `nodejs12.x`,
+`nodejs14.x`, `nodejs16.x`, `nodejs18.x`.
 
 > **As an application builder, we do not recommend you use this provider type.** This provider exists purely for custom resources that are part of the AWS Construct Library.
 >
@@ -1061,6 +1061,31 @@ since the top-level key is an unresolved token. The call to `findInMap` will ret
 region_table.find_in_map(Aws.REGION, "regionName")
 ```
 
+An optional default value can also be passed to `findInMap`. If either key is not found in the map and the mapping is lazy, `findInMap` will return the default value and not render the mapping.
+If the mapping is not lazy or either key is an unresolved token, the call to `findInMap` will return a token that resolves to
+`{ "Fn::FindInMap": [ "MapName", "TopLevelKey", "SecondLevelKey", { "DefaultValue": "DefaultValue" } ] }`, and the mapping will be rendered.
+Note that the `AWS::LanguageExtentions` transform is added to enable the default value functionality.
+
+For example, the following code will again not produce anything in the "Mappings" section. The
+call to `findInMap` will be able to resolve the value during synthesis and simply return
+`'Region not found'`.
+
+```python
+region_table = CfnMapping(self, "RegionTable",
+    mapping={
+        "us-east-1": {
+            "region_name": "US East (N. Virginia)"
+        },
+        "us-east-2": {
+            "region_name": "US East (Ohio)"
+        }
+    },
+    lazy=True
+)
+
+region_table.find_in_map("us-west-1", "regionName", "Region not found")
+```
+
 ### Dynamic References
 
 CloudFormation supports [dynamically resolving](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) values
@@ -1141,6 +1166,13 @@ stack = Stack(app, "StackName",
 )
 ```
 
+You can also set termination protection with the setter after you've instantiated the stack.
+
+```python
+stack = Stack(app, "StackName")
+stack.termination_protection = True
+```
+
 By default, termination protection is disabled.
 
 ### Description
@@ -1199,6 +1231,20 @@ It's possible to synthesize the project with more Resources than the allowed (or
 
 Set the context key `@aws-cdk/core:stackResourceLimit` with the proper value, being 0 for disable the limit of resources.
 
+### Template Indentation
+
+The AWS CloudFormation templates generated by CDK include indentation by default.
+Indentation makes the templates more readable, but also increases their size,
+and CloudFormation templates cannot exceed 1MB.
+
+It's possible to reduce the size of your templates by suppressing indentation.
+
+To do this for all templates, set the context key `@aws-cdk/core:suppressTemplateIndentation` to `true`.
+
+To do this for a specific stack, add a `suppressTemplateIndentation: true` property to the
+stack's `StackProps` parameter. You can also set this property to `false` to override
+the context key setting.
+
 ## App Context
 
 [Context values](https://docs.aws.amazon.com/cdk/v2/guide/context.html) are key-value pairs that can be associated with an app, stack, or construct.
@@ -1392,6 +1438,10 @@ class MyPlugin:
         )
 ```
 
+In addition to the name, plugins may optionally report their version (`version`
+property ) and a list of IDs of the rules they are going to evaluate (`ruleIds`
+property).
+
 Note that plugins are not allowed to modify anything in the cloud assembly. Any
 attempt to do so will result in synthesis failure.
 
@@ -1404,4 +1454,40 @@ add it to the `postinstall`
 [script](https://docs.npmjs.com/cli/v9/using-npm/scripts) in the `package.json`
 file.
 
+## Annotations
+
+Construct authors can add annotations to constructs to report at three different
+levels: `ERROR`, `WARN`, `INFO`.
+
+Typically warnings are added for things that are important for the user to be
+aware of, but will not cause deployment errors in all cases. Some common
+scenarios are (non-exhaustive list):
+
+* Warn when the user needs to take a manual action, e.g. IAM policy should be
+  added to an referenced resource.
+* Warn if the user configuration might not follow best practices (but is still
+  valid)
+* Warn if the user is using a deprecated API
+
+### Acknowledging Warnings
+
+If you would like to run with `--strict` mode enabled (warnings will throw
+errors) it is possible to `acknowledge` warnings to make the warning go away.
+
+For example, if > 10 IAM managed policies are added to an IAM Group, a warning
+will be created:
+
+```text
+IAM:Group:MaxPoliciesExceeded: You added 11 to IAM Group my-group. The maximum number of managed policies attached to an IAM group is 10.
+```
+
+If you have requested a [quota increase](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entities)
+you may have the ability to add > 10 managed policies which means that this
+warning does not apply to you. You can acknowledge this by `acknowledging` the
+warning by the `id`.
+
+```python
+Annotations.of(self).acknowledge_warning("IAM:Group:MaxPoliciesExceeded", "Account has quota increased to 20")
+```
+
 <!--END CORE DOCUMENTATION-->

{aws-cdk-lib-2.117.0 → aws-cdk-lib-2.119.0}/setup.py

@@ -5,7 +5,7 @@ kwargs = json.loads(
     """
 {
     "name": "aws-cdk-lib",
-    "version": "2.117.0",
+    "version": "2.119.0",
     "description": "Version 2 of the AWS Cloud Development Kit library",
     "license": "Apache-2.0",
     "url": "https://github.com/aws/aws-cdk",
@@ -24,6 +24,7 @@ kwargs = json.loads(
         "aws_cdk",
         "aws_cdk._jsii",
         "aws_cdk.alexa_ask",
+        "aws_cdk.amzn_sdc",
         "aws_cdk.assertions",
         "aws_cdk.aws_accessanalyzer",
         "aws_cdk.aws_acmpca",
@@ -82,6 +83,7 @@ kwargs = json.loads(
         "aws_cdk.aws_codestar",
         "aws_cdk.aws_codestarconnections",
         "aws_cdk.aws_codestarnotifications",
+        "aws_cdk.aws_codetest",
         "aws_cdk.aws_cognito",
         "aws_cdk.aws_comprehend",
         "aws_cdk.aws_config",
@@ -296,7 +298,7 @@ kwargs = json.loads(
     ],
     "package_data": {
         "aws_cdk._jsii": [
-            "aws-cdk-lib@2.117.0.jsii.tgz"
+            "aws-cdk-lib@2.119.0.jsii.tgz"
         ],
         "aws_cdk": [
             "py.typed"
@@ -308,7 +310,7 @@ kwargs = json.loads(
         "aws-cdk.asset-kubectl-v20>=2.1.2, <3.0.0",
         "aws-cdk.asset-node-proxy-agent-v6>=2.0.1, <3.0.0",
         "constructs>=10.0.0, <11.0.0",
-        "jsii>=1.93.0, <2.0.0",
+        "jsii>=1.94.0, <2.0.0",
         "publication>=0.0.3",
         "typeguard~=2.13.3"
     ],