Skip to content

docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector #4015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seshubaws merged 1 commit into from
Oct 13, 2026
Merged

docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector #4015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions samtranslator/internal/schema_source/aws_serverless_networkconnector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,13 @@ class Properties(BaseModel):
Name: SamIntrinsicable[str] | None = properties("Name")
VpcConfig: VpcConfig = properties("VpcConfig")
# The single compute type a connector serves. Constrained here (exactly one item; enum values) so
# `sam validate --lint` surfaces the same rules as the transform. Plain field (no doc stem) to avoid
# churning sam-docs.json; intrinsics still validate via SamIntrinsicable.
# `sam validate --lint` surfaces the same rules as the transform; intrinsics still validate via SamIntrinsicable.
ComputeTypes: list[SamIntrinsicable[Literal["MicroVm", "WebFunction"]]] | None = pydantic.Field(
default=None, min_items=1, max_items=1
default=None,
min_items=1,
max_items=1,
title="ComputeTypes",
markdownDescription=properties("ComputeTypes").extra["markdownDescription"],
Comment thread
seshubaws marked this conversation as resolved.
)
OperatorRole: SamIntrinsicable[str] | None = properties("OperatorRole")
Tags: DictStrAny | None = properties("Tags")
Expand Down
51 changes: 28 additions & 23 deletions samtranslator/internal/schema_source/aws_serverless_webfunction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,38 @@
BaseModel,
ResourceAttributes,
SamIntrinsicable,
get_prop,
)

PROPERTIES_STEM = "sam-resource-webfunction"

properties = get_prop(PROPERTIES_STEM)


class Properties(BaseModel):
Runtime: SamIntrinsicable[str]
CodeUri: Any | None = None
FunctionName: SamIntrinsicable[str] | None = None
Timeout: SamIntrinsicable[int] | None = None
EnvironmentVariables: dict[str, Any] | None = None
ExecutionRoleArn: Any | None = None
EndpointName: SamIntrinsicable[str] | None = None
EndpointType: SamIntrinsicable[str] | None = None
EndpointDescription: SamIntrinsicable[str] | None = None
AuthType: SamIntrinsicable[str]
AutoDeploymentMode: SamIntrinsicable[str] | None = None
RevisionWeights: dict[str, Any] | None = None
ReplicaRegions: Any | None = None
RevisionDescription: SamIntrinsicable[str] | None = None
KmsKeyArn: SamIntrinsicable[str] | None = None
LoggingConfig: dict[str, Any] | None = None
ScalingConfig: dict[str, Any] | None = None
ThrottleConfig: dict[str, Any] | None = None
MaxConcurrencyPerEnvironment: SamIntrinsicable[int] | None = None
EgressNetworkConnectorArn: SamIntrinsicable[str] | None = None
EntryPoint: SamIntrinsicable[str] | None = None
InlineCode: str | None = None
Tags: dict[str, Any] | None = None
Runtime: SamIntrinsicable[str] = properties("Runtime")
CodeUri: Any | None = properties("CodeUri")
FunctionName: SamIntrinsicable[str] | None = properties("FunctionName")
Timeout: SamIntrinsicable[int] | None = properties("Timeout")
EnvironmentVariables: dict[str, Any] | None = properties("EnvironmentVariables")
ExecutionRoleArn: Any | None = properties("ExecutionRoleArn")
EndpointName: SamIntrinsicable[str] | None = properties("EndpointName")
EndpointType: SamIntrinsicable[str] | None = properties("EndpointType")
EndpointDescription: SamIntrinsicable[str] | None = properties("EndpointDescription")
AuthType: SamIntrinsicable[str] = properties("AuthType")
AutoDeploymentMode: SamIntrinsicable[str] | None = properties("AutoDeploymentMode")
RevisionWeights: dict[str, Any] | None = properties("RevisionWeights")
ReplicaRegions: Any | None = properties("ReplicaRegions")
RevisionDescription: SamIntrinsicable[str] | None = properties("RevisionDescription")
KmsKeyArn: SamIntrinsicable[str] | None = properties("KmsKeyArn")
LoggingConfig: dict[str, Any] | None = properties("LoggingConfig")
ScalingConfig: dict[str, Any] | None = properties("ScalingConfig")
ThrottleConfig: dict[str, Any] | None = properties("ThrottleConfig")
MaxConcurrencyPerEnvironment: SamIntrinsicable[int] | None = properties("MaxConcurrencyPerEnvironment")
EgressNetworkConnectorArn: SamIntrinsicable[str] | None = properties("EgressNetworkConnectorArn")
EntryPoint: SamIntrinsicable[str] | None = properties("EntryPoint")
InlineCode: str | None = properties("InlineCode")
Tags: dict[str, Any] | None = properties("Tags")


class Resource(ResourceAttributes):
Expand Down
Loading
Loading