serverless-application-model API reference

73 public APIs from serverless-application-model (awslabs/serverless-application-model) — 55 classes, 13 functions, 5 methods. Signatures extracted by static analysis of the actual source.

Repository: awslabs/serverless-application-model

Kind	Count
Classes	55
Functions	13
Methods	5

API list

methodbin.json-format.JSONFormatter.format_str(input_str:str) -> str

Opinionated format JSON file.

classintegration.helpers.s3_uploader.S3Uploader

Class to upload objects to S3 bucket.

classsamtranslator.feature_toggle.dialup.DisabledDialup

A dialup that is never enabled

func

samtranslator.internal.deprecation_control.deprecated(replacement:str | None=None) -> Callable[[Callable[PT, RT]], Callable[PT, RT]]

Mark a function/method as deprecated.

funcsamtranslator.internal.utils.utils.passthrough_value(v:PassThroughProp | None) -> PassThrough

Cast PassThroughProp values to PassThrough.

classsamtranslator.intrinsics.actions.Action

Base class for intrinsic function actions.

funcsamtranslator.intrinsics.actions.SubAction.do_replacement(full_ref:str, prop_name:str) -> Any

Replace parameter references with actual value.

classsamtranslator.metrics.method_decorator.MetricsMethodWrapperSingleton

Keeps the instance of Metrics object.

classsamtranslator.metrics.metrics.MetricDatum

Class to hold Metric data.

method

samtranslator.metrics.metrics.Metrics.record_count(name:str, value:int, dimensions:list['MetricDimension'] | None=None, timestamp:datetime | None=None) -> None

Create metric with unit Count.

classsamtranslator.metrics.metrics.MetricsPublisher

Interface for all MetricPublishers

classsamtranslator.model.GeneratedProperty

Property of a generated CloudFormation resource.

classsamtranslator.model.MutatedPassThroughProperty

Mutated pass-through property.

classsamtranslator.model.PassThroughProperty

Pass-through property.

classsamtranslator.model.Property

Like `PropertyType`, except without intrinsics support.

methodsamtranslator.model.Resource.assign_tags(tags:dict[str, Any]) -> None

Assigns tags to the resource.

methodsamtranslator.model.Resource.set_resource_attribute(attr:str, value:Any) -> None

Sets attributes on resource.

classsamtranslator.model.ResourceMacro

A ResourceMacro object represents a CloudFormation macro.

classsamtranslator.model.StringEnumExpectedType

Expected type wrapper for string enum validators.

classsamtranslator.model.capacity_provider.resources.LambdaCapacityProvider

AWS::Lambda::CapacityProvider resource

func

samtranslator.model.connector.connector.add_depends_on(logical_id:str, depends_on:str, resource_resolver:ResourceResolver) -> None

Add DependsOn attribute to resource.

classsamtranslator.model.eventsources.pull.DocumentDB

DocumentDB event source.

classsamtranslator.model.eventsources.pull.DynamoDB

DynamoDB Streams event source.

classsamtranslator.model.eventsources.pull.Kinesis

Kinesis event source.

classsamtranslator.model.eventsources.pull.MQ

MQ event source.

classsamtranslator.model.eventsources.pull.MSK

MSK event source.

classsamtranslator.model.eventsources.pull.PullEventSource

Base class for pull event sources for SAM Functions.

classsamtranslator.model.eventsources.pull.SQS

SQS Queue event source.

classsamtranslator.model.eventsources.pull.SelfManagedKafka

SelfManagedKafka event source

classsamtranslator.model.eventsources.push.Api

Api method event source for SAM Functions.

classsamtranslator.model.eventsources.push.HttpApi

Api method event source for SAM Functions.

classsamtranslator.model.eventsources.push.S3

S3 bucket event source for SAM Functions.

classsamtranslator.model.eventsources.push.SNS

SNS topic event source for SAM Functions.

classsamtranslator.model.eventsources.push.Schedule

Scheduled executions for SAM Functions.

classsamtranslator.model.exceptions.InvalidEventException

Exception raised when an event is invalid.

classsamtranslator.model.exceptions.InvalidResourceException

Exception raised when a resource is invalid.

funcsamtranslator.model.intrinsics.is_intrinsic(_input:Any) -> bool

Checks if the given _input is an intrinsic function dictionary.

funcsamtranslator.model.intrinsics.is_intrinsic_if(_input:Any) -> bool

Is the given input an intrinsic if?

funcsamtranslator.model.intrinsics.is_intrinsic_no_value(_input:Any) -> bool

Is the given input an intrinsic Ref: AWS::NoValue?

classsamtranslator.model.lambda_.LambdaLayerVersion

Lambda layer version resource

classsamtranslator.model.microvm_image.generators.MicroVMImageGenerator

Generator for Lambda MicroVMImage resources

classsamtranslator.model.microvm_image.resources.LambdaMicroVMImage

AWS::Lambda::MicrovmImage resource

classsamtranslator.model.network_connector.resources.LambdaNetworkConnector

AWS::Lambda::NetworkConnector resource

classsamtranslator.model.sam_resources.SamApi

SAM rest API macro.

classsamtranslator.model.sam_resources.SamApplication

SAM application macro.

classsamtranslator.model.sam_resources.SamCapacityProvider

SAM CapacityProvider resource transformer

classsamtranslator.model.sam_resources.SamConnector

Sam connector macro.

classsamtranslator.model.sam_resources.SamFunction

SAM function macro.

methodsamtranslator.model.sam_resources.SamFunction.order_events(event:tuple[str, Any]) -> Any

Helper method for sorting Function Events.

classsamtranslator.model.sam_resources.SamGraphQLApi

SAM GraphQL API Macro.

classsamtranslator.model.sam_resources.SamHttpApi

SAM rest API macro.

classsamtranslator.model.sam_resources.SamLayerVersion

SAM Layer macro

classsamtranslator.model.sam_resources.SamMicroVMImage

SAM MicrovmImage resource transformer

classsamtranslator.model.sam_resources.SamNetworkConnector

SAM NetworkConnector resource transformer

classsamtranslator.model.sam_resources.SamSimpleTable

SAM simple table macro.

classsamtranslator.model.sam_resources.SamStateMachine

SAM state machine macro.

classsamtranslator.model.sam_resources.SamWebSocketApi

SAM WebSocket API Macro

classsamtranslator.model.stepfunctions.events.Api

Api method event source for SAM State Machines.

classsamtranslator.model.stepfunctions.events.Schedule

Scheduled executions for SAM State Machine.

classsamtranslator.plugins.LifeCycleEvents

Enum of LifeCycleEvents

classsamtranslator.plugins.globals.globals.GlobalProperties.TOKEN

Enum of tokens used in the merging

classsamtranslator.policy_template_processor.template.Template

Class representing a single policy template.

classsamtranslator.sdk.parameter.SamParameterValues

Class representing SAM parameter values.

classsamtranslator.sdk.resource.SamResource

Class representing a SAM resource.

classsamtranslator.sdk.resource.SamResourceType

Enum of supported SAM types

classsamtranslator.sdk.template.SamTemplate

Class representing the SAM template

func

samtranslator.translator.verify_logical_id.verify_unique_logical_id(resource:Resource, existing_resources:dict[str, Any]) -> bool

Return true if the logical id is unique.

classsamtranslator.utils.actions.Action

Base class for Resolver function actions.

funcsamtranslator.utils.cfn_dynamic_references.is_dynamic_reference(_input:Any) -> bool

Checks if the given input is a dynamic reference.

funcsamtranslator.utils.utils.as_array(x:Any) -> list[Any]

Convert value to list if it already isn't.

funcsamtranslator.utils.utils.dict_deep_get(d:Any, path:Union[str, list[str]]) -> Any | None

Get the value deep in the dict.

funcsamtranslator.utils.utils.dict_deep_set(d:Any, path:str, value:Any) -> None

Set the value deep in the dict.

funcsamtranslator.yaml_helper.yaml_parse(yamlstr)

Parse a yaml string

About this data

These signatures were extracted from the public source of awslabs/serverless-application-model using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries