Skip to content

Commit 90d7119

Browse files
aaythapaaahung
aaythapa
and
aahung
authored
chore: update properties in schema with new docs (#3026)
Co-authored-by: _sam <[email protected]>
1 parent c666efa commit 90d7119

File tree

8 files changed

+421
-98
lines changed

8 files changed

+421
-98
lines changed

‎samtranslator/internal/schema_source/aws_serverless_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ class LambdaTokenAuthorizer(BaseModel):
7777
FunctionInvokeRole: Optional[str] = lambdatokenauthorizer("FunctionInvokeRole")
7878
FunctionPayloadType: Optional[Literal["TOKEN"]] = lambdatokenauthorizer("FunctionPayloadType")
7979
Identity: Optional[LambdaTokenAuthorizerIdentity] = lambdatokenauthorizer("Identity")
80-
DisableFunctionDefaultPermissions: Optional[bool] # TODO Add docs
80+
DisableFunctionDefaultPermissions: Optional[bool] = lambdatokenauthorizer("DisableFunctionDefaultPermissions")
8181

8282

8383
class LambdaRequestAuthorizer(BaseModel):
@@ -86,7 +86,7 @@ class LambdaRequestAuthorizer(BaseModel):
8686
FunctionInvokeRole: Optional[str] = lambdarequestauthorizer("FunctionInvokeRole")
8787
FunctionPayloadType: Optional[Literal["REQUEST"]] = lambdarequestauthorizer("FunctionPayloadType")
8888
Identity: Optional[LambdaRequestAuthorizerIdentity] = lambdarequestauthorizer("Identity")
89-
DisableFunctionDefaultPermissions: Optional[bool] # TODO Add docs
89+
DisableFunctionDefaultPermissions: Optional[bool] = lambdarequestauthorizer("DisableFunctionDefaultPermissions")
9090

9191

9292
class UsagePlan(BaseModel):

‎samtranslator/internal/schema_source/aws_serverless_connector.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
resourcereference = get_prop("sam-property-connector-resourcereference")
88
properties = get_prop("sam-resource-connector")
9+
sourcereference = get_prop("sam-property-connector-sourcereference")
910

1011
PermissionsType = List[Literal["Read", "Write"]]
1112

@@ -32,12 +33,12 @@ class Resource(ResourceAttributes):
3233
Properties: Properties
3334

3435

35-
class SourceReference(BaseModel):
36-
Qualifier: Optional[PassThroughProp] = resourcereference("Qualifier")
36+
class SourceReferenceProperties(BaseModel):
37+
Qualifier: Optional[PassThroughProp] = sourcereference("Qualifier")
3738

3839

3940
class EmbeddedConnectorProperties(BaseModel):
40-
SourceReference: Optional[SourceReference] # TODO: add docs for SourceReference
41+
SourceReference: Optional[SourceReferenceProperties] = properties("SourceReference")
4142
Destination: Union[ResourceReference, List[ResourceReference]] = properties("Destination")
4243
Permissions: PermissionsType = properties("Permissions")
4344

‎samtranslator/internal/schema_source/aws_serverless_function.py

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
deadletterconfig = get_prop("sam-property-function-deadletterconfig")
2626
deploymentpreference = get_prop("sam-property-function-deploymentpreference")
2727
dlq = get_prop("sam-property-function-deadletterqueue")
28+
documentdbeventproperties = get_prop("sam-property-function-documentdb")
2829
dynamodbeventproperties = get_prop("sam-property-function-dynamodb")
2930
event = get_prop("sam-property-function-eventsource")
3031
eventbridgeruleeventproperties = get_prop("sam-property-function-eventbridgerule")
@@ -201,18 +202,20 @@ class DynamoDBEvent(BaseModel):
201202

202203

203204
class DocumentDBEventProperties(BaseModel):
204-
BatchSize: Optional[PassThroughProp] # TODO: add documentation
205-
Cluster: PassThroughProp # TODO: add documentation
206-
CollectionName: Optional[PassThroughProp] # TODO: add documentation
207-
DatabaseName: PassThroughProp # TODO: add documentation
208-
Enabled: Optional[PassThroughProp] # TODO: add documentation
209-
FilterCriteria: Optional[PassThroughProp] # TODO: add documentation
210-
FullDocument: Optional[PassThroughProp] # TODO: add documentation
211-
MaximumBatchingWindowInSeconds: Optional[PassThroughProp] # TODO: add documentation
212-
SecretsManagerKmsKeyId: Optional[str] # TODO: add documentation
213-
SourceAccessConfigurations: PassThroughProp # TODO: add documentation
214-
StartingPosition: Optional[PassThroughProp] # TODO: add documentation
215-
StartingPositionTimestamp: Optional[PassThroughProp] # TODO: add documentation
205+
BatchSize: Optional[PassThroughProp] = documentdbeventproperties("BatchSize")
206+
Cluster: PassThroughProp = documentdbeventproperties("Cluster")
207+
CollectionName: Optional[PassThroughProp] = documentdbeventproperties("CollectionName")
208+
DatabaseName: PassThroughProp = documentdbeventproperties("DatabaseName")
209+
Enabled: Optional[PassThroughProp] = documentdbeventproperties("Enabled")
210+
FilterCriteria: Optional[PassThroughProp] = documentdbeventproperties("FilterCriteria")
211+
FullDocument: Optional[PassThroughProp] = documentdbeventproperties("FullDocument")
212+
MaximumBatchingWindowInSeconds: Optional[PassThroughProp] = documentdbeventproperties(
213+
"MaximumBatchingWindowInSeconds"
214+
)
215+
SecretsManagerKmsKeyId: Optional[str] = documentdbeventproperties("SecretsManagerKmsKeyId")
216+
SourceAccessConfigurations: PassThroughProp = documentdbeventproperties("SourceAccessConfigurations")
217+
StartingPosition: Optional[PassThroughProp] = documentdbeventproperties("StartingPosition")
218+
StartingPositionTimestamp: Optional[PassThroughProp] = documentdbeventproperties("StartingPositionTimestamp")
216219

217220

218221
class DocumentDBEvent(BaseModel):
@@ -395,7 +398,7 @@ class MSKEventProperties(BaseModel):
395398
StartingPositionTimestamp: Optional[PassThroughProp] = mskeventproperties("StartingPositionTimestamp")
396399
Stream: PassThroughProp = mskeventproperties("Stream")
397400
Topics: PassThroughProp = mskeventproperties("Topics")
398-
SourceAccessConfigurations: Optional[PassThroughProp] # TODO: update docs when live
401+
SourceAccessConfigurations: Optional[PassThroughProp] = mskeventproperties("SourceAccessConfigurations")
399402

400403

401404
class MSKEvent(BaseModel):
@@ -491,7 +494,7 @@ class Properties(BaseModel):
491494
Architectures: Optional[Architectures] = prop("Architectures")
492495
AssumeRolePolicyDocument: Optional[AssumeRolePolicyDocument] = prop("AssumeRolePolicyDocument")
493496
AutoPublishAlias: Optional[AutoPublishAlias] = prop("AutoPublishAlias")
494-
AutoPublishAliasAllProperties: Optional[AutoPublishAliasAllProperties] # TODO: add docs
497+
AutoPublishAliasAllProperties: Optional[AutoPublishAliasAllProperties] = prop("AutoPublishAliasAllProperties")
495498
AutoPublishCodeSha256: Optional[SamIntrinsicable[str]] = prop("AutoPublishCodeSha256")
496499
CodeSigningConfigArn: Optional[SamIntrinsicable[str]] = prop("CodeSigningConfigArn")
497500
CodeUri: Optional[CodeUriType] = prop("CodeUri")
@@ -546,7 +549,7 @@ class Properties(BaseModel):
546549
Role: Optional[SamIntrinsicable[str]] = prop("Role")
547550
Runtime: Optional[Runtime] = prop("Runtime")
548551
SnapStart: Optional[SnapStart] = prop("SnapStart")
549-
RuntimeManagementConfig: Optional[RuntimeManagementConfig] # TODO: add prop and types
552+
RuntimeManagementConfig: Optional[RuntimeManagementConfig] = prop("RuntimeManagementConfig")
550553
Tags: Optional[Tags] = prop("Tags")
551554
Timeout: Optional[Timeout] = prop("Timeout")
552555
Tracing: Optional[Tracing] = prop("Tracing")
@@ -579,7 +582,7 @@ class Globals(BaseModel):
579582
Architectures: Optional[Architectures] = prop("Architectures")
580583
EphemeralStorage: Optional[EphemeralStorage] = prop("EphemeralStorage")
581584
SnapStart: Optional[SnapStart] = prop("SnapStart")
582-
RuntimeManagementConfig: Optional[RuntimeManagementConfig] # TODO: add prop
585+
RuntimeManagementConfig: Optional[RuntimeManagementConfig] = prop("RuntimeManagementConfig")
583586

584587

585588
class Resource(ResourceAttributes):

‎samtranslator/internal/schema_source/aws_serverless_httpapi.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ class Properties(BaseModel):
127127
StageName: Optional[PassThroughProp] = properties("StageName")
128128
StageVariables: Optional[StageVariables] = properties("StageVariables")
129129
Tags: Optional[Tags] = properties("Tags")
130-
Name: Optional[PassThroughProp] # TODO: Add to docs
130+
Name: Optional[PassThroughProp] = properties("Name")
131131

132132

133133
class Globals(BaseModel):

‎samtranslator/internal/schema_source/aws_serverless_statemachine.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
apieventproperties = get_prop("sam-property-statemachine-statemachineapi")
2626
apiauth = get_prop("sam-property-statemachine-apistatemachineauth")
2727
event = get_prop("sam-property-statemachine-statemachineeventsource")
28+
scheduletarget = get_prop("sam-property-statemachine-statemachinescheduletarget")
29+
eventtarget = get_prop("sam-property-statemachine-statemachinetarget")
2830

2931

3032
class DeadLetterConfig(BaseModel):
@@ -34,7 +36,7 @@ class DeadLetterConfig(BaseModel):
3436

3537

3638
class ScheduleTarget(BaseModel):
37-
Id: PassThroughProp # TODO: Add docs
39+
Id: PassThroughProp = scheduletarget("Id")
3840

3941

4042
class ScheduleEventProperties(BaseModel):
@@ -46,7 +48,7 @@ class ScheduleEventProperties(BaseModel):
4648
RetryPolicy: Optional[PassThroughProp] = scheduleeventproperties("RetryPolicy")
4749
Schedule: Optional[PassThroughProp] = scheduleeventproperties("Schedule")
4850
State: Optional[PassThroughProp] = scheduleeventproperties("State")
49-
Target: Optional[ScheduleTarget] # TODO: Add docs
51+
Target: Optional[ScheduleTarget] = scheduleeventproperties("Target")
5052

5153

5254
class ScheduleEvent(BaseModel):
@@ -104,7 +106,7 @@ class CloudWatchEvent(BaseModel):
104106

105107

106108
class EventBridgeRuleTarget(BaseModel):
107-
Id: PassThroughProp # TODO: Add docs
109+
Id: PassThroughProp = eventtarget("Id")
108110

109111

110112
class EventBridgeRuleEventProperties(BaseModel):
@@ -114,7 +116,7 @@ class EventBridgeRuleEventProperties(BaseModel):
114116
InputPath: Optional[PassThroughProp] = eventbridgeruleeventproperties("InputPath")
115117
Pattern: Optional[PassThroughProp] = eventbridgeruleeventproperties("Pattern")
116118
RetryPolicy: Optional[PassThroughProp] = eventbridgeruleeventproperties("RetryPolicy")
117-
Target: Optional[EventBridgeRuleTarget] # TODO: Add docs
119+
Target: Optional[EventBridgeRuleTarget] = eventbridgeruleeventproperties("Target")
118120

119121

120122
class EventBridgeRuleEvent(BaseModel):
@@ -134,7 +136,7 @@ class ApiEventProperties(BaseModel):
134136
Method: str = apieventproperties("Method")
135137
Path: str = apieventproperties("Path")
136138
RestApiId: Optional[SamIntrinsicable[str]] = apieventproperties("RestApiId")
137-
UnescapeMappingTemplate: Optional[bool] # TODO: Add to docs
139+
UnescapeMappingTemplate: Optional[bool] = apieventproperties("UnescapeMappingTemplate")
138140

139141

140142
class ApiEvent(BaseModel):
@@ -163,7 +165,7 @@ class Properties(BaseModel):
163165
PermissionsBoundary: Optional[PassThroughProp] = properties("PermissionsBoundary")
164166
Policies: Optional[Union[str, DictStrAny, List[Union[str, DictStrAny]]]] = properties("Policies")
165167
Role: Optional[PassThroughProp] = properties("Role")
166-
RolePath: Optional[PassThroughProp] # TODO: Add docs
168+
RolePath: Optional[PassThroughProp] = properties("RolePath")
167169
Tags: Optional[DictStrAny] = properties("Tags")
168170
Tracing: Optional[PassThroughProp] = properties("Tracing")
169171
Type: Optional[PassThroughProp] = properties("Type")

0 commit comments

Comments
 (0)