aws-cdk-lib 2.73.0__py3-none-any.whl → 2.76.0__py3-none-any.whl

{aws_cdk_lib-2.73.0.dist-info → aws_cdk_lib-2.76.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk-lib
-Version: 2.73.0
+Version: 2.76.0
 Summary: Version 2 of the AWS Cloud Development Kit library
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services
@@ -60,10 +60,8 @@ According to the kind of project you are developing:
 You can use a classic import to get access to each service namespaces:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 from aws_cdk import Stack, App, aws_s3 as s3
 
-
 app = App()
 stack = Stack(app, "TestStack")
 
@@ -75,11 +73,9 @@ s3.Bucket(stack, "TestBucket")
 Alternatively, you can use "barrel" imports:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 from aws_cdk import App, Stack
 from aws_cdk.aws_s3 import Bucket
 
-
 app = App()
 stack = Stack(app, "TestStack")
 
@@ -153,7 +149,6 @@ Each of these synthesizers takes configuration arguments. To configure
 a stack with a synthesizer, pass it as one of its properties:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 MyStack(app, "MyStack",
     synthesizer=DefaultStackSynthesizer(
         file_assets_bucket_name="my-orgs-asset-bucket"
@@ -175,7 +170,6 @@ For example, assume that you have a load balancer configuration that you use for
 The following example will define a single top-level stack that contains two nested stacks: each one with a single Amazon S3 bucket:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 class MyNestedStack(cfn.NestedStack):
     def __init__(self, scope, id, *, parameters=None, timeout=None, notifications=None):
         super().__init__(scope, id, parameters=parameters, timeout=timeout, notifications=notifications)
@@ -207,7 +201,6 @@ which defines an Amazon S3 bucket. Then it defines a second stack, `stack2`,
 which takes the bucket from stack1 as a constructor property.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 prod = {"account": "123456789012", "region": "us-east-1"}
 
 stack1 = StackThatProvidesABucket(app, "Stack1", env=prod)
@@ -238,7 +231,6 @@ enabled it is possible to do something like creating a CloudFront distribution i
 an ACM certificate in `us-east-1`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 stack1 = Stack(app, "Stack1",
     env=Environment(
         region="us-east-1"
@@ -322,7 +314,6 @@ An instance of Duration is constructed by using one of the static factory
 methods on it:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 Duration.seconds(300) # 5 minutes
 Duration.minutes(5) # 5 minutes
 Duration.hours(1) # 1 hour
@@ -333,7 +324,6 @@ Duration.parse("PT5M")
 Durations can be added or subtracted together:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 Duration.minutes(1).plus(Duration.seconds(60)) # 2 minutes
 Duration.minutes(5).minus(Duration.seconds(10))
 ```
@@ -346,7 +336,6 @@ To make specification of digital storage quantities unambiguous, a class called
 An instance of `Size` is initialized through one of its static factory methods:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 Size.kibibytes(200) # 200 KiB
 Size.mebibytes(5) # 5 MiB
 Size.gibibytes(40) # 40 GiB
@@ -359,7 +348,6 @@ By default, conversion to a higher unit will fail if the conversion does not pro
 a whole number. This can be overridden by unsetting `integral` property.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 Size.mebibytes(2).to_kibibytes() # yields 2048
 Size.kibibytes(2050).to_mebibytes(rounding=SizeRoundingBehavior.FLOOR)
 ```
@@ -373,7 +361,6 @@ a password or an access key) will take a parameter of type `SecretValue`.
 The best practice is to store secrets in AWS Secrets Manager and reference them using `SecretValue.secretsManager`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 secret = SecretValue.secrets_manager("secretId",
     json_field="password",  # optional: key of a JSON field to retrieve (defaults to all content),
     version_id="id",  # optional: id of the version (default AWSCURRENT)
@@ -416,7 +403,6 @@ this purpose.
 use the region and account of the stack you're calling it on:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # stack: Stack
 
 
@@ -435,7 +421,6 @@ 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.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # stack: Stack
 
 
@@ -477,7 +462,6 @@ following creates a single object that represents a dependency on two
 constructs, `constructB` and `constructC`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # Declare the dependable object
 b_and_c = DependencyGroup()
 b_and_c.add(construct_b)
@@ -530,7 +514,6 @@ of arbitrarily many custom resource definitions. A single definition looks like
 this:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CustomResource(self, "MyMagicalResource",
     resource_type="Custom::MyCustomResource",  # must start with 'Custom::'
 
@@ -584,7 +567,6 @@ Here is a basic pattern for defining stack singletons in the CDK. The following
 examples ensures that only a single SNS topic is defined:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 def get_or_create(self, scope):
     stack = Stack.of(scope)
     uniqueid = "GloballyUniqueIdForSingleton" # For example, a UUID from `uuidgen`
@@ -610,7 +592,6 @@ CloudFormation service.
 Set `serviceToken` to `topic.topicArn`  in order to use this provider:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 topic = sns.Topic(self, "MyProvider")
 
 CustomResource(self, "MyResource",
@@ -631,7 +612,6 @@ response to the CloudFormation service and handle various error cases.
 Set `serviceToken` to `lambda.functionArn` to use this provider:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 fn = lambda_.Function(self, "MyProvider", function_props)
 
 CustomResource(self, "MyResource",
@@ -656,7 +636,6 @@ The provider has a built-in singleton method which uses the resource type as a
 stack-unique identifier and returns the service token:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 service_token = CustomResourceProvider.get_or_create(self, "Custom::MyCustomResourceType",
     code_directory=f"{__dirname}/my-handler",
     runtime=CustomResourceProviderRuntime.NODEJS_14_X,
@@ -732,8 +711,8 @@ exports.handler = async (e) => {
 `sum.ts`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-from aws_cdk.core import Construct, CustomResource, CustomResourceProvider, CustomResourceProviderRuntime, Token
+from constructs import Construct
+from aws_cdk import CustomResource, CustomResourceProvider, CustomResourceProviderRuntime, Token
 
 class Sum(Construct):
 
@@ -761,7 +740,6 @@ class Sum(Construct):
 Usage will look like this:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 sum = Sum(self, "MySum", lhs=40, rhs=2)
 CfnOutput(self, "Result", value=Token.as_string(sum.result))
 ```
@@ -770,7 +748,6 @@ To access the ARN of the provider's AWS Lambda function role, use the `getOrCrea
 built-in singleton method:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 provider = CustomResourceProvider.get_or_create_provider(self, "Custom::MyCustomResourceType",
     code_directory=f"{__dirname}/my-handler",
     runtime=CustomResourceProviderRuntime.NODEJS_14_X
@@ -784,7 +761,6 @@ This role ARN can then be used in resource-based IAM policies.
 To add IAM policy statements to this role, use `addToRolePolicy()`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 provider = CustomResourceProvider.get_or_create_provider(self, "Custom::MyCustomResourceType",
     code_directory=f"{__dirname}/my-handler",
     runtime=CustomResourceProviderRuntime.NODEJS_14_X
@@ -813,7 +789,6 @@ allows implementing providers that can take up to two hours to stabilize.
 Set `serviceToken` to `provider.serviceToken` to use this type of provider:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 provider = customresources.Provider(self, "MyProvider",
     on_event_handler=on_event_handler,
     is_complete_handler=is_complete_handler
@@ -838,7 +813,6 @@ CloudFormation [stack outputs](https://docs.aws.amazon.com/AWSCloudFormation/lat
 the `CfnOutput` class:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CfnOutput(self, "OutputName",
     value=my_bucket.bucket_name,
     description="The name of an S3 bucket",  # Optional
@@ -858,7 +832,6 @@ stack to the AWS CDK).
 Template parameters can be added to a stack by using the `CfnParameter` class:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CfnParameter(self, "MyParameter",
     type="Number",
     default=1337
@@ -871,7 +844,6 @@ placeholder tokens for the real value (`Token.isUnresolved()` would return `true
 for those):
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 param = CfnParameter(self, "ParameterName")
 
 # If the parameter is a String
@@ -895,7 +867,6 @@ instead, which guarantees the values produced are qualifying the designated
 stack, which is essential in cases where resources are shared cross-stack:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # "this" is the current construct
 stack = Stack.of(self)
 
@@ -911,7 +882,6 @@ attributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-p
 accessing those through the `cfnOptions` property:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 raw_bucket = s3.CfnBucket(self, "Bucket")
 # -or-
 raw_bucket_alt = my_bucket.node.default_child
@@ -927,7 +897,6 @@ Resource dependencies (the `DependsOn` attribute) is modified using the
 `cfnResource.addDependency` method:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 resource_a = CfnResource(self, "ResourceA", resource_props)
 resource_b = CfnResource(self, "ResourceB", resource_props)
 
@@ -945,18 +914,17 @@ a property of the creationPolicy on the resource options. Setting it to true wil
 resources that depend on the fleet resource.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-fleet = CfnFleet(stack, "Fleet",
+fleet = appstream.CfnFleet(self, "Fleet",
     instance_type="stream.standard.small",
     name="Fleet",
-    compute_capacity={
-        "desired_instances": 1
-    },
+    compute_capacity=appstream.CfnFleet.ComputeCapacityProperty(
+        desired_instances=1
+    ),
     image_name="AppStream-AmazonLinux2-09-21-2022"
 )
-fleet.cfn_options.creation_policy = {
-    "start_fleet": True
-}
+fleet.cfn_options.creation_policy = CfnCreationPolicy(
+    start_fleet=True
+)
 ```
 
 The properties passed to the level 2 constructs `AutoScalingGroup` and `Instance` from the
@@ -969,11 +937,15 @@ The format of the timeout is `PT#H#M#S`. In the example below AWS Cloudformation
 `CREATE_COMPLETE`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-resource.cfn_options.resource_signal = {
-    "count": 3,
-    "timeout": "PR15M"
-}
+# resource: CfnResource
+
+
+resource.cfn_options.creation_policy = CfnCreationPolicy(
+    resource_signal=CfnResourceSignal(
+        count=3,
+        timeout="PR15M"
+    )
+)
 ```
 
 ### Intrinsic Functions and Condition Expressions
@@ -983,7 +955,6 @@ can be accessed from the `Fn` class, which provides type-safe methods for each
 intrinsic function as well as condition expressions:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # my_object_or_array: Any
 # my_array: Any
 
@@ -1013,7 +984,6 @@ needs to be expressed with un-resolved values, it is necessary to use
 CloudFormation conditions by means of the `CfnCondition` class:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 environment_parameter = CfnParameter(self, "Environment")
 is_prod = CfnCondition(self, "IsProduction",
     expression=Fn.condition_equals("Production", environment_parameter)
@@ -1035,7 +1005,6 @@ CloudFormation [mappings](https://docs.aws.amazon.com/AWSCloudFormation/latest/U
 `CfnMappings` class:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 region_table = CfnMapping(self, "RegionTable",
     mapping={
         "us-east-1": {
@@ -1071,7 +1040,6 @@ call to `findInMap` will be able to resolve the value during synthesis and simpl
 `'US East (Ohio)'`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 region_table = CfnMapping(self, "RegionTable",
     mapping={
         "us-east-1": {
@@ -1092,7 +1060,6 @@ since the top-level key is an unresolved token. The call to `findInMap` will ret
 `{ "Fn::FindInMap": [ "RegionTable", { "Ref": "AWS::Region" }, "regionName" ] }`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # region_table: CfnMapping
 
 
@@ -1106,7 +1073,6 @@ for SSM parameters (including secure strings) and Secrets Manager. Encoding such
 references is done using the `CfnDynamicReference` class:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CfnDynamicReference(CfnDynamicReferenceService.SECRETS_MANAGER, "secret-id:secret-string:json-key:version-stage:version-id")
 ```
 
@@ -1117,7 +1083,6 @@ CloudFormation templates support a number of options, including which Macros or
 configured using the `stack.templateOptions` property:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 stack = Stack(app, "StackName")
 
 stack.template_options.description = "This will appear in the AWS console"
@@ -1133,7 +1098,6 @@ The `CfnResource` class allows emitting arbitrary entries in the
 [Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html) section of the CloudFormation template.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CfnResource(self, "ResourceId",
     type="AWS::S3::Bucket",
     properties={
@@ -1153,7 +1117,6 @@ include fragments of an existing template verbatim in the synthesized template.
 This can be achieved using the `CfnInclude` class.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 CfnInclude(self, "ID",
     template={
         "Resources": {
@@ -1178,7 +1141,6 @@ nested stacks belonging to that stack as well. You can enable termination protec
 on a stack by setting the `terminationProtection` prop to `true`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 stack = Stack(app, "StackName",
     termination_protection=True
 )
@@ -1191,7 +1153,6 @@ By default, termination protection is disabled.
 You can add a description of the stack in the same way as `StackProps`.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 stack = Stack(app, "StackName",
     description="This is a description."
 )
@@ -1211,7 +1172,6 @@ The following example defines an IAM role which can only be assumed by
 principals that are tagged with a specific tag.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 tag_param = CfnParameter(self, "TagName")
 
 string_equals = CfnJson(self, "ConditionJson",
@@ -1262,7 +1222,6 @@ top take precedence over those below).
 ### Examples of setting context
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 App(
     context={
         "@aws-cdk/core:newStyleStackSynthesis": True
@@ -1271,13 +1230,11 @@ App(
 ```
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 app = App()
 app.node.set_context("@aws-cdk/core:newStyleStackSynthesis", True)
 ```
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 App(
     post_cli_context={
         "@aws-cdk/core:newStyleStackSynthesis": True
@@ -1324,10 +1281,6 @@ to all roles within a specific construct scope. The most common use case would
 be to apply a permissions boundary at the `Stage` level.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-# app: App
-
-
 prod_stage = Stage(app, "ProdStage",
     permissions_boundary=PermissionsBoundary.from_name("cdk-${Qualifier}-PermissionsBoundary")
 )
@@ -1360,11 +1313,10 @@ To use one or more validation plugins in your application, use the
 `policyValidationBeta1` property of `Stage`:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 # globally for the entire app (an app is a stage)
 app = App(
     policy_validation_beta1=[
-        # These hypothetical classes implement IValidationPlugin:
+        # These hypothetical classes implement IPolicyValidationPluginBeta1:
         ThirdPartyPluginX(),
         ThirdPartyPluginY()
     ]
@@ -1372,7 +1324,9 @@ app = App(
 
 # only apply to a particular stage
 prod_stage = Stage(app, "ProdStage",
-    policy_validation_beta1=[...]
+    policy_validation_beta1=[
+        ThirdPartyPluginX()
+    ]
 )
 ```
 
@@ -1392,7 +1346,6 @@ report in JSON format, enable it using the `@aws-cdk/core:validationReportJson`
 context passing it directly to the application:
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
 app = App(
     context={"@aws-cdk/core:validationReportJson": True}
 )
@@ -1410,36 +1363,38 @@ the standard output.
 ### For plugin authors
 
 The communication protocol between the CDK core module and your policy tool is
-defined by the `IValidationPluginBeta1` interface. To create a new plugin you must
+defined by the `IPolicyValidationPluginBeta1` interface. To create a new plugin you must
 write a class that implements this interface. There are two things you need to
 implement: the plugin name (by overriding the `name` property), and the
 `validate()` method.
 
-The framework will call `validate()`, passing an `IValidationContextBeta1` object.
+The framework will call `validate()`, passing an `IPolicyValidationContextBeta1` object.
 The location of the templates to be validated is given by `templatePaths`. The
-plugin should return an instance of `ValidationPluginReportBeta1`. This object
+plugin should return an instance of `PolicyValidationPluginReportBeta1`. This object
 represents the report that the user wil receive at the end of the synthesis.
 
 ```python
-# Example automatically generated from non-compiling source. May contain errors.
-validate(context, ValidationContextBeta1)ValidationReportBeta1
-    # First read the templates using context.templatePaths...
-
-    # ...then perform the validation, and then compose and return the report.
-    # Using hard-coded values here for better clarity:
-    return {
-        "success": False,
-        "violations": [{
-            "rule_name": "CKV_AWS_117",
-            "recommendation": "Ensure that AWS Lambda function is configured inside a VPC",
-            "fix": "https://docs.bridgecrew.io/docs/ensure-that-aws-lambda-function-is-configured-inside-a-vpc-1",
-            "violating_resources": [{
-                "resource_name": "MyFunction3BAA72D1",
-                "template_path": "/home/johndoe/myapp/cdk.out/MyService.template.json",
-                "locations": "Properties/VpcConfig"
-            }]
-        }]
-    }
+@jsii.implements(IPolicyValidationPluginBeta1)
+class MyPlugin:
+
+    def validate(self, context):
+        # First read the templates using context.templatePaths...
+
+        # ...then perform the validation, and then compose and return the report.
+        # Using hard-coded values here for better clarity:
+        return PolicyValidationPluginReportBeta1(
+            success=False,
+            violations=[PolicyViolationBeta1(
+                rule_name="CKV_AWS_117",
+                description="Ensure that AWS Lambda function is configured inside a VPC",
+                fix="https://docs.bridgecrew.io/docs/ensure-that-aws-lambda-function-is-configured-inside-a-vpc-1",
+                violating_resources=[PolicyViolatingResourceBeta1(
+                    resource_logical_id="MyFunction3BAA72D1",
+                    template_path="/home/johndoe/myapp/cdk.out/MyService.template.json",
+                    locations=["Properties/VpcConfig"]
+                )]
+            )]
+        )
 ```
 
 Note that plugins are not allowed to modify anything in the cloud assembly. Any