Merge pull request #535 from awslabs/python_and_example_updates

Update rdklib templates and support python 3.13

Author: bmorrissirromb

README.md

@@ -92,10 +92,10 @@ rdk init --generate-lambda-layer --custom-layer-name <LAYER_NAME>
 
 In your working directory, use the `create` command to start creating a new custom rule. You must specify the runtime for the Lambda function that will back the Rule, and you can also specify a resource type (or comma-separated list of types) that the Rule will evaluate or a maximum frequency for a periodic rule. This will add a new directory for the rule and populate it with several files, including a skeleton of your Lambda code.
 
-> :warning: By default, if you do not specify a runtime, `rdk` will select the latest `rdklib` Python runtime (eg. `python3.12-lib`). If you use an `rdklib` runtime, you will need to have `rdklib` Lambda layer installed in your AWS account (see `--generate-lambda-layer` in `rdk init` above), and will need `rdklib` installed locally if you plan to run unit tests locally. Alternatively, you can explicitly specify a non-`rdklib` runtime like `python3.12`.
+> :warning: By default, if you do not specify a runtime, `rdk` will select the latest `rdklib` Python runtime (eg. `python3.13-lib`). If you use an `rdklib` runtime, you will need to have `rdklib` Lambda layer installed in your AWS account (see `--generate-lambda-layer` in `rdk init` above), and will need `rdklib` installed locally if you plan to run unit tests locally. Alternatively, you can explicitly specify a non-`rdklib` runtime like `python3.13`.
 
 ```bash
-rdk create MyRule --runtime python3.12 --resource-types AWS::EC2::Instance --input-parameters '{"desiredInstanceType":"t2.micro"}'
+rdk create MyRule --runtime python3.13 --resource-types AWS::EC2::Instance --input-parameters '{"desiredInstanceType":"t2.micro"}'
 Running create!
 Local Rule files created.
 ```
@@ -162,7 +162,7 @@ The test file includes setup for the MagicMock library that can be used to stub
 If you need to change the parameters of a Config rule in your working directory you can use the `modify` command. Any parameters you specify will overwrite existing values, any that you do not specify will not be changed.
 
 ```bash
-rdk modify MyRule --runtime python3.12 --maximum-frequency TwentyFour_Hours --input-parameters '{"desiredInstanceType":"t2.micro"}'
+rdk modify MyRule --runtime python3.13 --maximum-frequency TwentyFour_Hours --input-parameters '{"desiredInstanceType":"t2.micro"}'
 Running modify!
 Modified Rule 'MyRule'.  Use the `deploy` command to push your changes to AWS.
 ```
@@ -259,7 +259,7 @@ CloudFormation template written to remote-rule-template.json
 It is now possible to define a resource type that is not yet supported by `rdk`. To disable the supported resource check use the optional flag `--skip-supported-resource-check` during the create command.
 
 ```bash
-rdk create MyRule --runtime python3.12 --resource-types AWS::New::ResourceType --skip-supported-resource-check
+rdk create MyRule --runtime python3.13 --resource-types AWS::New::ResourceType --skip-supported-resource-check
 'AWS::New::ResourceType' not found in list of accepted resource types.
 Skip-Supported-Resource-Check Flag set (--skip-supported-resource-check), ignoring missing resource type error.
 Running create!
@@ -274,7 +274,7 @@ As of version 0.7.14, instead of defaulting the lambda function names to `RDK-Ru
 2. Custom lambda function naming as per personal or enterprise standards.
 
 ```bash
-rdk create MyLongerRuleName --runtime python3.12 --resource-types AWS::EC2::Instance --custom-lambda-name custom-prefix-for-MyLongerRuleName
+rdk create MyLongerRuleName --runtime python3.13 --resource-types AWS::EC2::Instance --custom-lambda-name custom-prefix-for-MyLongerRuleName
 Running create!
 Local Rule files created.
 ```

docs/index.md

@@ -92,10 +92,10 @@ rdk init --generate-lambda-layer --custom-layer-name <LAYER_NAME>
 
 In your working directory, use the `create` command to start creating a new custom rule. You must specify the runtime for the Lambda function that will back the Rule, and you can also specify a resource type (or comma-separated list of types) that the Rule will evaluate or a maximum frequency for a periodic rule. This will add a new directory for the rule and populate it with several files, including a skeleton of your Lambda code.
 
-> :warning: By default, if you do not specify a runtime, `rdk` will select the latest `rdklib` Python runtime (eg. `python3.12-lib`). If you use an `rdklib` runtime, you will need to have `rdklib` Lambda layer installed in your AWS account (see `--generate-lambda-layer` in `rdk init` above), and will need `rdklib` installed locally if you plan to run unit tests locally. Alternatively, you can explicitly specify a non-`rdklib` runtime like `python3.12`.
+> :warning: By default, if you do not specify a runtime, `rdk` will select the latest `rdklib` Python runtime (eg. `python3.13-lib`). If you use an `rdklib` runtime, you will need to have `rdklib` Lambda layer installed in your AWS account (see `--generate-lambda-layer` in `rdk init` above), and will need `rdklib` installed locally if you plan to run unit tests locally. Alternatively, you can explicitly specify a non-`rdklib` runtime like `python3.13`.
 
 ```bash
-rdk create MyRule --runtime python3.12 --resource-types AWS::EC2::Instance --input-parameters '{"desiredInstanceType":"t2.micro"}'
+rdk create MyRule --runtime python3.13 --resource-types AWS::EC2::Instance --input-parameters '{"desiredInstanceType":"t2.micro"}'
 Running create!
 Local Rule files created.
 ```
@@ -162,7 +162,7 @@ The test file includes setup for the MagicMock library that can be used to stub
 If you need to change the parameters of a Config rule in your working directory you can use the `modify` command. Any parameters you specify will overwrite existing values, any that you do not specify will not be changed.
 
 ```bash
-rdk modify MyRule --runtime python3.12 --maximum-frequency TwentyFour_Hours --input-parameters '{"desiredInstanceType":"t2.micro"}'
+rdk modify MyRule --runtime python3.13 --maximum-frequency TwentyFour_Hours --input-parameters '{"desiredInstanceType":"t2.micro"}'
 Running modify!
 Modified Rule 'MyRule'.  Use the `deploy` command to push your changes to AWS.
 ```
@@ -259,7 +259,7 @@ CloudFormation template written to remote-rule-template.json
 It is now possible to define a resource type that is not yet supported by `rdk`. To disable the supported resource check use the optional flag `--skip-supported-resource-check` during the create command.
 
 ```bash
-rdk create MyRule --runtime python3.12 --resource-types AWS::New::ResourceType --skip-supported-resource-check
+rdk create MyRule --runtime python3.13 --resource-types AWS::New::ResourceType --skip-supported-resource-check
 'AWS::New::ResourceType' not found in list of accepted resource types.
 Skip-Supported-Resource-Check Flag set (--skip-supported-resource-check), ignoring missing resource type error.
 Running create!
@@ -274,7 +274,7 @@ As of version 0.7.14, instead of defaulting the lambda function names to `RDK-Ru
 2. Custom lambda function naming as per personal or enterprise standards.
 
 ```bash
-rdk create MyLongerRuleName --runtime python3.12 --resource-types AWS::EC2::Instance --custom-lambda-name custom-prefix-for-MyLongerRuleName
+rdk create MyLongerRuleName --runtime python3.13 --resource-types AWS::EC2::Instance --custom-lambda-name custom-prefix-for-MyLongerRuleName
 Running create!
 Local Rule files created.
 ```

pyproject.toml

@@ -7,7 +7,7 @@
 #    or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 [tool.poetry]
 name = "rdk"
-version = "0.17.18"
+version = "0.17.19"
 description = "Rule Development Kit CLI for AWS Config"
 authors = [
     "AWS RDK Maintainers <[email protected]>",
@@ -28,6 +28,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 include = [
     "README.md",
@@ -55,6 +56,8 @@ include = [
     "rdk/template/runtime/python3.11-lib/*",
     "rdk/template/runtime/python3.12/*",
     "rdk/template/runtime/python3.12-lib/*",
+    "rdk/template/runtime/python3.13/*",
+    "rdk/template/runtime/python3.13-lib/*",
     "rdk/template/runtime/dotnetcore1.0/*",
     "rdk/template/runtime/dotnetcore1.0/bin/*",
     "rdk/template/runtime/dotnetcore1.0/obj/*",

rdk/__init__.py

@@ -6,4 +6,4 @@
 #
 #    or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
-MY_VERSION = "0.17.18"
+MY_VERSION = "0.17.19"

rdk/rdk.py

@@ -275,6 +275,8 @@ def get_rule_parser(is_required, command):
             "python3.11-lib",
             "python3.12",
             "python3.12-lib",
+            "python3.13",
+            "python3.13-lib",
         ],
         metavar="",
     )
@@ -289,7 +291,7 @@ def get_rule_parser(is_required, command):
         required=False,
         help="[optional] Provide custom lambda name",
     )
-    parser.set_defaults(runtime="python3.12-lib")
+    parser.set_defaults(runtime="python3.13-lib")
     parser.add_argument(
         "-r",
         "--resource-types",
@@ -1238,6 +1240,8 @@ def create(self):
                 "python3.11-lib": ".py",
                 "python3.12": ".py",
                 "python3.12-lib": ".py",
+                "python3.13": ".py",
+                "python3.13-lib": ".py",
             }
             if self.args.runtime not in extension_mapping:
                 print("rdk does not support that runtime yet.")
@@ -1283,6 +1287,7 @@ def create(self):
                             "python3.10-lib",
                             "python3.11-lib",
                             "python3.12-lib",
+                            "python3.13-lib",
                         ]:
                             if self.args.resource_types:
                                 applicable_resource_list = ""
@@ -2675,6 +2680,8 @@ def test_local(self):
                 "python3.11-lib",
                 "python3.12",
                 "python3.12-lib",
+                "python3.13",
+                "python3.13-lib",
             ):
                 print("Skipping " + rule_name + " - Runtime not supported for local testing.")
                 continue
@@ -3909,6 +3916,8 @@ def __get_handler(self, rule_name, params):
             "python3.11-lib",
             "python3.12",
             "python3.12-lib",
+            "python3.13",
+            "python3.13-lib",
         ]:
             return rule_name + ".lambda_handler"
         elif params["SourceRuntime"] in ["java8"]:
@@ -3922,6 +3931,7 @@ def __get_runtime_string(self, params):
             "python3.10-lib",
             "python3.11-lib",
             "python3.12-lib",
+            "python3.13-lib",
         ]:
             runtime = params["SourceRuntime"].split("-")
             return runtime[0]
@@ -4316,6 +4326,7 @@ def __get_lambda_layers(self, my_session, args, params):
                 "python3.10-lib",
                 "python3.11-lib",
                 "python3.12-lib",
+                "python3.13-lib",
             ]:
                 if hasattr(args, "generated_lambda_layer") and args.generated_lambda_layer:
                     lambda_layer_version = self.__get_existing_lambda_layer(
@@ -4449,6 +4460,7 @@ def __create_new_lambda_layer_locally(self, my_session, layer_name="rdklib-layer
                 "python3.10",
                 "python3.11",
                 "python3.12",
+                "python3.13",
             ],
         )
 

rdk/template/runtime/python3.10-lib/rule_code.py

@@ -1,15 +1,33 @@
 from rdklib import Evaluator, Evaluation, ConfigRule, ComplianceType
 <%ApplicableResources1%>
 class <%RuleName%>(ConfigRule):
+    # NOTE - you should typically only implement one of evaluate_change() or evaluate_periodic()!
+    # If implementing a periodic rule, you will need to delete evaluate_change() and uncomment evaluate_periodic()
+
     def evaluate_change(self, event, client_factory, configuration_item, valid_rule_parameters):
-        ###############################
-        # Add your custom logic here. #
-        ###############################
+        ################################################
+        # Add your custom change-triggered logic here. #
+        ################################################
 
         return [Evaluation(ComplianceType.NOT_APPLICABLE)]
 
-    #def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
-    #    pass
+
+    # def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
+    # ########################################
+    # # Add your custom periodic logic here. #
+    # ########################################
+    # # If you are evaluating resources that are not supported by the Config Service...
+    # # ...it is often helpful to specify the account as the resource type/ID 
+    #     account_id = event['accountId']
+    #     return [
+    #         Evaluation(
+    #             complianceType=ComplianceType.COMPLIANT,
+    #             resourceId=account_id,
+    #             resourceType="AWS::::Account",
+    #             annotation="Use this field to explain why this evaluation occurred.",
+    #         )
+    #     ]
+            
 
     def evaluate_parameters(self, rule_parameters):
         valid_rule_parameters = rule_parameters

rdk/template/runtime/python3.11-lib/rule_code.py

@@ -1,15 +1,33 @@
 from rdklib import Evaluator, Evaluation, ConfigRule, ComplianceType
 <%ApplicableResources1%>
 class <%RuleName%>(ConfigRule):
+    # NOTE - you should typically only implement one of evaluate_change() or evaluate_periodic()!
+    # If implementing a periodic rule, you will need to delete evaluate_change() and uncomment evaluate_periodic()
+
     def evaluate_change(self, event, client_factory, configuration_item, valid_rule_parameters):
-        ###############################
-        # Add your custom logic here. #
-        ###############################
+        ################################################
+        # Add your custom change-triggered logic here. #
+        ################################################
 
         return [Evaluation(ComplianceType.NOT_APPLICABLE)]
 
-    #def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
-    #    pass
+
+    # def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
+    # ########################################
+    # # Add your custom periodic logic here. #
+    # ########################################
+    # # If you are evaluating resources that are not supported by the Config Service...
+    # # ...it is often helpful to specify the account as the resource type/ID 
+    #     account_id = event['accountId']
+    #     return [
+    #         Evaluation(
+    #             complianceType=ComplianceType.COMPLIANT,
+    #             resourceId=account_id,
+    #             resourceType="AWS::::Account",
+    #             annotation="Use this field to explain why this evaluation occurred.",
+    #         )
+    #     ]
+            
 
     def evaluate_parameters(self, rule_parameters):
         valid_rule_parameters = rule_parameters

rdk/template/runtime/python3.12-lib/rule_code.py

@@ -1,15 +1,33 @@
 from rdklib import Evaluator, Evaluation, ConfigRule, ComplianceType
 <%ApplicableResources1%>
 class <%RuleName%>(ConfigRule):
+    # NOTE - you should typically only implement one of evaluate_change() or evaluate_periodic()!
+    # If implementing a periodic rule, you will need to delete evaluate_change() and uncomment evaluate_periodic()
+
     def evaluate_change(self, event, client_factory, configuration_item, valid_rule_parameters):
-        ###############################
-        # Add your custom logic here. #
-        ###############################
+        ################################################
+        # Add your custom change-triggered logic here. #
+        ################################################
 
         return [Evaluation(ComplianceType.NOT_APPLICABLE)]
 
-    #def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
-    #    pass
+
+    # def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
+    # ########################################
+    # # Add your custom periodic logic here. #
+    # ########################################
+    # # If you are evaluating resources that are not supported by the Config Service...
+    # # ...it is often helpful to specify the account as the resource type/ID 
+    #     account_id = event['accountId']
+    #     return [
+    #         Evaluation(
+    #             complianceType=ComplianceType.COMPLIANT,
+    #             resourceId=account_id,
+    #             resourceType="AWS::::Account",
+    #             annotation="Use this field to explain why this evaluation occurred.",
+    #         )
+    #     ]
+            
 
     def evaluate_parameters(self, rule_parameters):
         valid_rule_parameters = rule_parameters

rdk/template/runtime/python3.13-lib/rule_code.py

@@ -0,0 +1,43 @@
+from rdklib import Evaluator, Evaluation, ConfigRule, ComplianceType
+<%ApplicableResources1%>
+class <%RuleName%>(ConfigRule):
+    # NOTE - you should typically only implement one of evaluate_change() or evaluate_periodic()!
+    # If implementing a periodic rule, you will need to delete evaluate_change() and uncomment evaluate_periodic()
+
+    def evaluate_change(self, event, client_factory, configuration_item, valid_rule_parameters):
+        ################################################
+        # Add your custom change-triggered logic here. #
+        ################################################
+
+        return [Evaluation(ComplianceType.NOT_APPLICABLE)]
+
+
+    # def evaluate_periodic(self, event, client_factory, valid_rule_parameters):
+    # ########################################
+    # # Add your custom periodic logic here. #
+    # ########################################
+    # # If you are evaluating resources that are not supported by the Config Service...
+    # # ...it is often helpful to specify the account as the resource type/ID 
+    #     account_id = event['accountId']
+    #     return [
+    #         Evaluation(
+    #             complianceType=ComplianceType.COMPLIANT,
+    #             resourceId=account_id,
+    #             resourceType="AWS::::Account",
+    #             annotation="Use this field to explain why this evaluation occurred.",
+    #         )
+    #     ]
+            
+
+    def evaluate_parameters(self, rule_parameters):
+        valid_rule_parameters = rule_parameters
+        return valid_rule_parameters
+
+
+################################
+# DO NOT MODIFY ANYTHING BELOW #
+################################
+def lambda_handler(event, context):
+    my_rule = <%RuleName%>()
+    evaluator = Evaluator(my_rule<%ApplicableResources2%>)
+    return evaluator.handle(event, context)