Skip to main content

Module bindings

Module bindings 

Source
Expand description

Type-safe binding parameter definitions

This module defines structs that represent the runtime parameters needed by bindings to interact with cloud resources. These structs are used by:

  • Controllers when returning binding parameters directly
  • Template generators when creating CloudFormation/Terraform templates (using Fn::ToJsonString)
  • Bindings when consuming runtime parameters (parsing JSON)

This provides type safety and ensures consistency across all parts of the system.

Structs§

AcaBuildBinding
Azure Container Apps Jobs binding configuration
AcrArtifactRegistryBinding
Azure Container Registry binding configuration
AwsServiceAccountBinding
AWS IAM Role service account binding configuration
AzureServiceAccountBinding
Azure User-Assigned Managed Identity binding configuration
BlobStorageBinding
Azure Blob Storage binding configuration
CloudRunFunctionBinding
GCP Cloud Run function binding configuration
CloudbuildBuildBinding
Google Cloud Build binding configuration
CodebuildBuildBinding
AWS CodeBuild binding configuration
ContainerAppFunctionBinding
Azure Container Apps function binding configuration
DynamodbKvBinding
AWS DynamoDB KV binding configuration
EcrArtifactRegistryBinding
AWS ECR (Elastic Container Registry) binding configuration
FirestoreKvBinding
GCP Firestore KV binding configuration
GarArtifactRegistryBinding
Google Artifact Registry binding configuration
GcpServiceAccountBinding
GCP Service Account binding configuration
GcsStorageBinding
Google Cloud Storage binding configuration
HorizonContainerBinding
Horizon container binding configuration (for cloud platforms)
KeyVaultBinding
Azure Key Vault binding configuration
KubernetesContainerBinding
Kubernetes container binding configuration
KubernetesFunctionBinding
Kubernetes function binding configuration
KubernetesSecretVaultBinding
Kubernetes Secrets vault binding configuration
LambdaFunctionBinding
AWS Lambda function binding configuration
LocalArtifactRegistryBinding
Local container registry binding configuration
LocalBuildBinding
Local build execution binding configuration
LocalContainerBinding
Local Docker container binding configuration
LocalFunctionBinding
Local function binding configuration
LocalKvBinding
Local development KV binding configuration
LocalStorageBinding
Local filesystem storage binding configuration
LocalVaultBinding
Local development vault binding (for testing/development)
ParameterStoreVaultBinding
AWS SSM Parameter Store vault binding configuration
PubSubQueueBinding
GCP Pub/Sub parameters
RedisKvBinding
Redis KV binding configuration
S3StorageBinding
AWS S3 storage binding configuration
SecretManagerVaultBinding
GCP Secret Manager vault binding configuration
SecretReference
Reference to a Kubernetes Secret
ServiceBusQueueBinding
Azure Service Bus parameters
SqsQueueBinding
AWS SQS queue parameters
TableStorageKvBinding
Azure Table Storage KV binding configuration

Enums§

ArtifactRegistryBinding
Service-type based artifact registry binding that supports multiple registry providers
BindingValue
Represents a value that can be either a concrete value, a template expression, or a reference to a Kubernetes Secret
BuildBinding
Service-type based build binding that supports multiple build providers
ContainerBinding
Represents a container binding for container-to-container or external communication
FunctionBinding
Represents a function binding for cross-function communication
KvBinding
Represents a KV binding for key-value storage across platforms
QueueBinding
Binding parameters for Queue at runtime or in templates.
ServiceAccountBinding
Represents a service account binding for identity management and impersonation
StorageBinding
Service-type based storage binding that supports multiple storage providers
VaultBinding
Represents a vault binding for secure secret management

Functions§

binding_env_var_name
Helper function to generate the environment variable name for a binding
parse_binding_from_env
Helper function to parse binding from environment variable
serialize_binding_as_env_var
Helper function to serialize binding struct as JSON for environment variables
serialize_binding_for_template
Helper function to serialize binding struct for CloudFormation templates