aws-cdk-lib 2.117.0__py3-none-any.whl → 2.119.0__py3-none-any.whl

aws_cdk/__init__.py

@@ -392,7 +392,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
@@ -406,12 +406,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.
@@ -421,14 +421,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)
@@ -608,7 +607,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
@@ -622,7 +621,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.
 >
@@ -1062,6 +1062,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
@@ -1142,6 +1167,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
@@ -1200,6 +1232,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.
@@ -1393,6 +1439,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.
 
@@ -1405,6 +1455,42 @@ 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-->
 '''
 import abc
@@ -2087,7 +2173,23 @@ class ArnComponents:
 
 @jsii.enum(jsii_type="aws-cdk-lib.ArnFormat")
 class ArnFormat(enum.Enum):
-    '''An enum representing the various ARN formats that different services use.'''
+    '''An enum representing the various ARN formats that different services use.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        # stack: Stack
+        
+        
+        # Builds "arn:<PARTITION>:lambda:<REGION>:<ACCOUNT>:function:MyFunction"
+        stack.format_arn(
+            service="lambda",
+            resource="function",
+            arn_format=ArnFormat.COLON_RESOURCE_NAME,
+            resource_name="MyFunction"
+        )
+    '''
 
     NO_RESOURCE_NAME = "NO_RESOURCE_NAME"
     '''This represents a format where there is no 'resourceName' part.
@@ -5562,10 +5664,11 @@ class CfnMappingProps:
                     "us-east-2": {
                         "region_name": "US East (Ohio)"
                     }
-                }
+                },
+                lazy=True
             )
             
-            region_table.find_in_map(Aws.REGION, "regionName")
+            region_table.find_in_map("us-east-2", "regionName")
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__1661eec8c4dedc5a4b0f85332d5dfada759b3dcd7d56d62c059c454e7cbfc838)
@@ -12025,21 +12128,27 @@ class Duration(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.Duration"):
 
     Example::
 
-        # application: appconfig.Application
-        # bucket: s3.Bucket
+        import aws_cdk.aws_ecs as ecs
         
+        # cluster: ecs.ICluster
+        # task_definition: ecs.TaskDefinition
         
-        appconfig.SourcedConfiguration(self, "MySourcedConfiguration",
-            application=application,
-            location=appconfig.ConfigurationSource.from_bucket(bucket, "path/to/file.json"),
-            deployment_strategy=appconfig.DeploymentStrategy(self, "MyDeploymentStrategy",
-                rollout_strategy=appconfig.RolloutStrategy.linear(
-                    growth_factor=15,
-                    deployment_duration=Duration.minutes(30),
-                    final_bake_time=Duration.minutes(15)
-                )
-            )
+        
+        rule = events.Rule(self, "Rule",
+            schedule=events.Schedule.rate(cdk.Duration.hours(1))
         )
+        
+        rule.add_target(
+            targets.EcsTask(
+                cluster=cluster,
+                task_definition=task_definition,
+                propagate_tags=ecs.PropagatedTagSource.TASK_DEFINITION,
+                tags=[targets.Tag(
+                    key="my-tag",
+                    value="my-tag-value"
+                )
+                ]
+            ))
     '''
 
     @jsii.member(jsii_name="days")
@@ -33657,6 +33766,7 @@ __all__ = [
     "ValidationResult",
     "ValidationResults",
     "alexa_ask",
+    "amzn_sdc",
     "assertions",
     "aws_accessanalyzer",
     "aws_acmpca",
@@ -33714,6 +33824,7 @@ __all__ = [
     "aws_codestar",
     "aws_codestarconnections",
     "aws_codestarnotifications",
+    "aws_codetest",
     "aws_cognito",
     "aws_comprehend",
     "aws_config",
@@ -33931,6 +34042,7 @@ publication.publish()
 
 # Loading modules to ensure their types are registered with the jsii runtime library
 from . import alexa_ask
+from . import amzn_sdc
 from . import assertions
 from . import aws_accessanalyzer
 from . import aws_acmpca
@@ -33988,6 +34100,7 @@ from . import aws_codepipeline_actions
 from . import aws_codestar
 from . import aws_codestarconnections
 from . import aws_codestarnotifications
+from . import aws_codetest
 from . import aws_cognito
 from . import aws_comprehend
 from . import aws_config

aws_cdk/_jsii/__init__.py

@@ -16,7 +16,7 @@ import aws_cdk.asset_node_proxy_agent_v6._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "aws-cdk-lib", "2.117.0", __name__[0:-6], "aws-cdk-lib@2.117.0.jsii.tgz"
+    "aws-cdk-lib", "2.119.0", __name__[0:-6], "aws-cdk-lib@2.119.0.jsii.tgz"
 )
 
 __all__ = [