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§
- AcaBuild
Binding - Azure Container Apps Jobs binding configuration
- AcrArtifact
Registry Binding - Azure Container Registry binding configuration
- AwsService
Account Binding - AWS IAM Role service account binding configuration
- Azure
Service Account Binding - Azure User-Assigned Managed Identity binding configuration
- Blob
Storage Binding - Azure Blob Storage binding configuration
- Cloud
RunFunction Binding - GCP Cloud Run function binding configuration
- Cloudbuild
Build Binding - Google Cloud Build binding configuration
- Codebuild
Build Binding - AWS CodeBuild binding configuration
- Container
AppFunction Binding - Azure Container Apps function binding configuration
- Dynamodb
KvBinding - AWS DynamoDB KV binding configuration
- EcrArtifact
Registry Binding - AWS ECR (Elastic Container Registry) binding configuration
- Firestore
KvBinding - GCP Firestore KV binding configuration
- GarArtifact
Registry Binding - Google Artifact Registry binding configuration
- GcpService
Account Binding - GCP Service Account binding configuration
- GcsStorage
Binding - Google Cloud Storage binding configuration
- Horizon
Container Binding - Horizon container binding configuration (for cloud platforms)
- KeyVault
Binding - Azure Key Vault binding configuration
- Kubernetes
Container Binding - Kubernetes container binding configuration
- Kubernetes
Function Binding - Kubernetes function binding configuration
- Kubernetes
Secret Vault Binding - Kubernetes Secrets vault binding configuration
- Lambda
Function Binding - AWS Lambda function binding configuration
- Local
Artifact Registry Binding - Local container registry binding configuration
- Local
Build Binding - Local build execution binding configuration
- Local
Container Binding - Local Docker container binding configuration
- Local
Function Binding - Local function binding configuration
- Local
KvBinding - Local development KV binding configuration
- Local
Storage Binding - Local filesystem storage binding configuration
- Local
Vault Binding - Local development vault binding (for testing/development)
- Parameter
Store Vault Binding - AWS SSM Parameter Store vault binding configuration
- PubSub
Queue Binding - GCP Pub/Sub parameters
- Redis
KvBinding - Redis KV binding configuration
- S3Storage
Binding - AWS S3 storage binding configuration
- Secret
Manager Vault Binding - GCP Secret Manager vault binding configuration
- Secret
Reference - Reference to a Kubernetes Secret
- Service
BusQueue Binding - Azure Service Bus parameters
- SqsQueue
Binding - AWS SQS queue parameters
- Table
Storage KvBinding - Azure Table Storage KV binding configuration
Enums§
- Artifact
Registry Binding - Service-type based artifact registry binding that supports multiple registry providers
- Binding
Value - Represents a value that can be either a concrete value, a template expression, or a reference to a Kubernetes Secret
- Build
Binding - Service-type based build binding that supports multiple build providers
- Container
Binding - Represents a container binding for container-to-container or external communication
- Function
Binding - Represents a function binding for cross-function communication
- KvBinding
- Represents a KV binding for key-value storage across platforms
- Queue
Binding - Binding parameters for Queue at runtime or in templates.
- Service
Account Binding - Represents a service account binding for identity management and impersonation
- Storage
Binding - Service-type based storage binding that supports multiple storage providers
- Vault
Binding - 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