Skip to content

Commit d9d5de4

Browse files
author
Ran Isenberg
committed
rename to cloudformation
1 parent 34adb1a commit d9d5de4

File tree

4 files changed

+48
-48
lines changed

4 files changed

+48
-48
lines changed

‎aws_lambda_powertools/utilities/parser/models/__init__.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@
1414
RequestContextV2AuthorizerJwt,
1515
RequestContextV2Http,
1616
)
17+
from .cloudformation_custom_resource import (
18+
CloudFormationCustomResourceBaseModel,
19+
CloudFormationCustomResourceCreateModel,
20+
CloudFormationCustomResourceDeleteModel,
21+
CloudFormationCustomResourceUpdateModel,
22+
)
1723
from .cloudwatch import (
1824
CloudWatchLogsData,
1925
CloudWatchLogsDecode,
2026
CloudWatchLogsLogEvent,
2127
CloudWatchLogsModel,
2228
)
23-
from .custom_resource import (
24-
CustomResourceBaseModel,
25-
CustomResourceCreateModel,
26-
CustomResourceDeleteModel,
27-
CustomResourceUpdateModel,
28-
)
2929
from .dynamodb import (
3030
DynamoDBStreamChangedRecordModel,
3131
DynamoDBStreamModel,
@@ -153,8 +153,8 @@
153153
"KafkaBaseEventModel",
154154
"KinesisFirehoseSqsModel",
155155
"KinesisFirehoseSqsRecord",
156-
"CustomResourceUpdateModel",
157-
"CustomResourceDeleteModel",
158-
"CustomResourceCreateModel",
159-
"CustomResourceBaseModel",
156+
"CloudFormationCustomResourceUpdateModel",
157+
"CloudFormationCustomResourceDeleteModel",
158+
"CloudFormationCustomResourceCreateModel",
159+
"CloudFormationCustomResourceBaseModel",
160160
]

‎aws_lambda_powertools/utilities/parser/models/custom_resource.py renamed to ‎aws_lambda_powertools/utilities/parser/models/cloudformation_custom_resource.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from aws_lambda_powertools.utilities.parser.types import Literal
66

77

8-
class CustomResourceBaseModel(BaseModel):
8+
class CloudFormationCustomResourceBaseModel(BaseModel):
99
request_type: str = Field(..., alias="RequestType")
1010
service_token: str = Field(..., alias="ServiceToken")
1111
response_url: HttpUrl = Field(..., alias="ResponseURL")
@@ -16,14 +16,14 @@ class CustomResourceBaseModel(BaseModel):
1616
resource_properties: Union[Dict[str, Any], Type[BaseModel]] = Field(..., alias="ResourceProperties")
1717

1818

19-
class CustomResourceCreateModel(CustomResourceBaseModel):
19+
class CloudFormationCustomResourceCreateModel(CloudFormationCustomResourceBaseModel):
2020
request_type: Literal["Create"] = Field(..., alias="RequestType")
2121

2222

23-
class CustomResourceDeleteModel(CustomResourceBaseModel):
23+
class CloudFormationCustomResourceDeleteModel(CloudFormationCustomResourceBaseModel):
2424
request_type: Literal["Delete"] = Field(..., alias="RequestType")
2525

2626

27-
class CustomResourceUpdateModel(CustomResourceBaseModel):
27+
class CloudFormationCustomResourceUpdateModel(CloudFormationCustomResourceBaseModel):
2828
request_type: Literal["Update"] = Field(..., alias="RequestType")
2929
old_resource_properties: Union[Dict[str, Any], Type[BaseModel]] = Field(..., alias="OldResourceProperties")

‎docs/utilities/parser.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -156,30 +156,30 @@ def my_function():
156156

157157
Parser comes with the following built-in models:
158158

159-
| Model name | Description |
160-
| --------------------------------------- | ------------------------------------------------------------------------------------- |
161-
| **AlbModel** | Lambda Event Source payload for Amazon Application Load Balancer |
162-
| **APIGatewayProxyEventModel** | Lambda Event Source payload for Amazon API Gateway |
163-
| **APIGatewayProxyEventV2Model** | Lambda Event Source payload for Amazon API Gateway v2 payload |
164-
| **CloudwatchLogsModel** | Lambda Event Source payload for Amazon CloudWatch Logs |
165-
| **DynamoDBStreamModel** | Lambda Event Source payload for Amazon DynamoDB Streams |
166-
| **EventBridgeModel** | Lambda Event Source payload for Amazon EventBridge |
167-
| **KafkaMskEventModel** | Lambda Event Source payload for AWS MSK payload |
168-
| **KafkaSelfManagedEventModel** | Lambda Event Source payload for self managed Kafka payload |
169-
| **KinesisDataStreamModel** | Lambda Event Source payload for Amazon Kinesis Data Streams |
170-
| **KinesisFirehoseModel** | Lambda Event Source payload for Amazon Kinesis Firehose |
171-
| **KinesisFirehoseSqsModel** | Lambda Event Source payload for SQS messages wrapped in Kinesis Firehose records |
172-
| **LambdaFunctionUrlModel** | Lambda Event Source payload for Lambda Function URL payload |
173-
| **S3EventNotificationEventBridgeModel** | Lambda Event Source payload for Amazon S3 Event Notification to EventBridge. |
174-
| **S3Model** | Lambda Event Source payload for Amazon S3 |
175-
| **S3ObjectLambdaEvent** | Lambda Event Source payload for Amazon S3 Object Lambda |
176-
| **S3SqsEventNotificationModel** | Lambda Event Source payload for S3 event notifications wrapped in SQS event (S3->SQS) |
177-
| **SesModel** | Lambda Event Source payload for Amazon Simple Email Service |
178-
| **SnsModel** | Lambda Event Source payload for Amazon Simple Notification Service |
179-
| **SqsModel** | Lambda Event Source payload for Amazon SQS |
180-
| **CustomResourceCreateModel** | Lambda Event Source payload for AWS CloudFormation 'create' custom resource |
181-
| **CustomResourceUpdateModel** | Lambda Event Source payload for AWS CloudFormation 'update' custom resource |
182-
| **CustomResourceDeleteModel** | Lambda Event Source payload for AWS CloudFormation 'delete' custom resource |
159+
| Model name | Description |
160+
| ------------------------------------------- | ------------------------------------------------------------------------------------- |
161+
| **AlbModel** | Lambda Event Source payload for Amazon Application Load Balancer |
162+
| **APIGatewayProxyEventModel** | Lambda Event Source payload for Amazon API Gateway |
163+
| **APIGatewayProxyEventV2Model** | Lambda Event Source payload for Amazon API Gateway v2 payload |
164+
| **CloudwatchLogsModel** | Lambda Event Source payload for Amazon CloudWatch Logs |
165+
| **DynamoDBStreamModel** | Lambda Event Source payload for Amazon DynamoDB Streams |
166+
| **EventBridgeModel** | Lambda Event Source payload for Amazon EventBridge |
167+
| **KafkaMskEventModel** | Lambda Event Source payload for AWS MSK payload |
168+
| **KafkaSelfManagedEventModel** | Lambda Event Source payload for self managed Kafka payload |
169+
| **KinesisDataStreamModel** | Lambda Event Source payload for Amazon Kinesis Data Streams |
170+
| **KinesisFirehoseModel** | Lambda Event Source payload for Amazon Kinesis Firehose |
171+
| **KinesisFirehoseSqsModel** | Lambda Event Source payload for SQS messages wrapped in Kinesis Firehose records |
172+
| **LambdaFunctionUrlModel** | Lambda Event Source payload for Lambda Function URL payload |
173+
| **S3EventNotificationEventBridgeModel** | Lambda Event Source payload for Amazon S3 Event Notification to EventBridge. |
174+
| **S3Model** | Lambda Event Source payload for Amazon S3 |
175+
| **S3ObjectLambdaEvent** | Lambda Event Source payload for Amazon S3 Object Lambda |
176+
| **S3SqsEventNotificationModel** | Lambda Event Source payload for S3 event notifications wrapped in SQS event (S3->SQS) |
177+
| **SesModel** | Lambda Event Source payload for Amazon Simple Email Service |
178+
| **SnsModel** | Lambda Event Source payload for Amazon Simple Notification Service |
179+
| **SqsModel** | Lambda Event Source payload for Amazon SQS |
180+
| **CloudFormationCustomResourceCreateModel** | Lambda Event Source payload for AWS CloudFormation 'create' custom resource |
181+
| **CloudFormationCustomResourceUpdateModel** | Lambda Event Source payload for AWS CloudFormation 'update' custom resource |
182+
| **CloudFormationCustomResourceDeleteModel** | Lambda Event Source payload for AWS CloudFormation 'delete' custom resource |
183183

184184
#### Extending built-in models
185185

‎tests/functional/parser/test_custom_resource.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33

44
from aws_lambda_powertools.utilities.parser import ValidationError, event_parser
55
from aws_lambda_powertools.utilities.parser.models import (
6-
CustomResourceCreateModel,
7-
CustomResourceDeleteModel,
8-
CustomResourceUpdateModel,
6+
CloudFormationCustomResourceCreateModel,
7+
CloudFormationCustomResourceDeleteModel,
8+
CloudFormationCustomResourceUpdateModel,
99
)
1010
from aws_lambda_powertools.utilities.typing import LambdaContext
1111
from tests.functional.utils import load_event
1212

1313

14-
@event_parser(model=CustomResourceCreateModel)
15-
def handle_create_custom_resource(event: CustomResourceCreateModel, _: LambdaContext):
14+
@event_parser(model=CloudFormationCustomResourceCreateModel)
15+
def handle_create_custom_resource(event: CloudFormationCustomResourceCreateModel, _: LambdaContext):
1616
assert event.request_type == "Create"
1717
assert event.request_id == "xxxxx-d2a0-4dfb-ab1f-xxxxxx"
1818
assert event.service_token == "arn:aws:lambda:us-east-1:xxx:function:xxxx-CrbuiltinfunctionidProvi-2vKAalSppmKe"
@@ -29,8 +29,8 @@ def handle_create_custom_resource(event: CustomResourceCreateModel, _: LambdaCon
2929
}
3030

3131

32-
@event_parser(model=CustomResourceUpdateModel)
33-
def handle_update_custom_resource(event: CustomResourceUpdateModel, _: LambdaContext):
32+
@event_parser(model=CloudFormationCustomResourceUpdateModel)
33+
def handle_update_custom_resource(event: CloudFormationCustomResourceUpdateModel, _: LambdaContext):
3434
assert event.request_type == "Update"
3535
assert event.request_id == "xxxxx-d2a0-4dfb-ab1f-xxxxxx"
3636
assert event.service_token == "arn:aws:lambda:us-east-1:xxx:function:xxxx-CrbuiltinfunctionidProvi-2vKAalSppmKe"
@@ -51,8 +51,8 @@ def handle_update_custom_resource(event: CustomResourceUpdateModel, _: LambdaCon
5151
}
5252

5353

54-
@event_parser(model=CustomResourceDeleteModel)
55-
def handle_delete_custom_resource(event: CustomResourceDeleteModel, _: LambdaContext):
54+
@event_parser(model=CloudFormationCustomResourceDeleteModel)
55+
def handle_delete_custom_resource(event: CloudFormationCustomResourceDeleteModel, _: LambdaContext):
5656
assert event.request_type == "Delete"
5757
assert event.request_id == "xxxxx-d2a0-4dfb-ab1f-xxxxxx"
5858
assert event.service_token == "arn:aws:lambda:us-east-1:xxx:function:xxxx-CrbuiltinfunctionidProvi-2vKAalSppmKe"
@@ -106,7 +106,7 @@ class MyModel(BaseModel):
106106
MyProps: str
107107

108108

109-
class MyCustomResource(CustomResourceCreateModel):
109+
class MyCustomResource(CloudFormationCustomResourceCreateModel):
110110
resource_properties: MyModel = Field(..., alias="ResourceProperties")
111111

112112

0 commit comments

Comments
 (0)