Skip to main content

​
Legend

​
Build

Build configuration for this module

​
ModuleBuild

Build configuration — discriminated by module build typeDiscriminated union. The type field selects which schema applies.

​
DisabledModuleBuild

Disabled build configuration for a module. Additional fields are ignored.
​
enum
required
Build type discriminatorAllowed values: disabled

​
ImageModuleBuild

Image build configuration for a module.
​
enum
required
Build type discriminatorAllowed values: image(templateable)
​
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
​
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
​
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
​
Pipeline.ImageBuildConfig
required
Builder configuration — dockerfile, nixpacks, or railpack settings.See: Pipeline.ImageBuildConfig(templateable)
​
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
​
boolean | null
Enable verbose build output for debugging build issues.(templateable)
​
Pipeline.EcrDestination[]
required
ECR destinations where the built Docker image will be pushed.See: Pipeline.EcrDestination(minItems:1; templateable)
​
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

​
LambdaModuleBuild

Lambda build configuration for a module. Produces a zip artifact uploaded to S3, sized for the Lambda Zip package type. Wraps the existing `Pipeline.BuildLam…
​
enum
required
Build type discriminatorAllowed values: lambda(templateable)
​
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
​
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
​
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
​
Pipeline.LambdaBuildConfig
required
Builder configuration — dockerfile or nixpacks settings for the Lambda zip build. Reuses the existing Pipeline.LambdaBuildConfig shape so module builds and…See: Pipeline.LambdaBuildConfig(templateable)
​
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
​
boolean | null
Enable verbose build output for debugging build issues.(templateable)
​
Pipeline.S3Destination[]
required
S3 destinations where the Lambda deployment package will be uploaded. At least one is required; the resulting key is passed to the deploy step as `deploy.inp…See: Pipeline.S3Destination(minItems:1; templateable)
​
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

​
StaticModuleBuild

Static build configuration for a module.
​
enum
required
Build type discriminatorAllowed values: static(templateable)
​
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
​
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
​
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
​
Pipeline.StaticBuildConfig
required
Builder configuration — dockerfile, nixpacks, or railpack settings.See: Pipeline.StaticBuildConfig(templateable)
​
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
​
boolean | null
Enable verbose build output for debugging build issues.(templateable)
​
Pipeline.S3Destination[]
required
S3 destinations where the built static assets will be uploaded.See: Pipeline.S3Destination(minItems:1; templateable)
​
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

​
Pipeline.EcrDestination

ECR destination for image builds
​
string
required
Unique destination identifier within the build step(templateable)
​
enum
required
ECR destination typeAllowed values: ecr(templateable)
​
string
required
ECR repository ARN(templateable)
​
string[] | null
Docker image tags to apply in ECR after the build finishes(templateable)

​
Pipeline.EnvironmentVariablesValue

Environment variable map value.One of: map<string,Pipeline.EnvironmentVariable>, string.

​
Pipeline.GitSource

Git source configuration for fetching code
​
enum
required
Source type identifierAllowed values: git(templateable)
​
string
required
Full repository URL including host(templateable)
​
string
required
Branch to check out(minLen:1; templateable)
​
string | null
Git ref to check out — branch, commit SHA, tag, or other ref. Overrides branch HEAD if set.(templateable)
​
string | null
default:"."
Base path within the repository to use as the working root(templateable)

​
Pipeline.ImageBuildConfig

Image build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

​
Pipeline.StepInfrastructure

Step infrastructure configuration
​
string | null
ID or given ID of a pre-configured execution environment(templateable)
​
string | null
AWS account reference for automatic network selection.(templateable)
​
string | null
AWS region for automatic network selection(templateable)
​
enum
required
Instance type — “ec2” for on-demand or “ec2-spot” for cheaper spot instancesAllowed values: ec2 | ec2-spot(templateable)
​
string | string[]
required
Instance size — a single size like “large” or an array like [“large”, “xlarge”] for spot fallback(templateable)
​
string | null
AMI ID for the runner instance(templateable)
​
Pipeline.AwsPermissions
IAM permissions for the runner role — “attach” to add policies or “replace” to override step defaultsSee: Pipeline.AwsPermissions(templateable)
​
Pipeline.StorageConfig
Root volume storage configurationSee: Pipeline.StorageConfig(templateable)

​
Pipeline.LambdaBuildConfig

Lambda build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

​
Pipeline.S3Destination

S3 destination for build artifacts
​
string
required
Unique destination identifier within the build step(minLen:1; templateable)
​
enum
required
S3 destination typeAllowed values: s3(templateable)
​
string
required
S3 bucket name where built assets will be uploaded(templateable)
​
string | null
S3 directory override for the uploaded build output.(templateable)
​
string
required
AWS region for the destination S3 bucket(templateable)

​
Pipeline.StaticBuildConfig

Static build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

​
Pipeline.EnvironmentVariable

Environment variable — can be a plain string, Parameter Store reference, or Secrets Manager referenceOne of: string | null, Pipeline.ParameterStoreEnvVar, Pipeline.SecretsManagerEnvVar.

​
Pipeline.DisabledBuildConfig

Disabled build configuration. Valid only for module-driven builds.
​
enum
required
Build method — disables module build executionAllowed values: disabled(templateable)

​
Pipeline.ImageDockerfileBuildConfig

Dockerfile configuration for image builds
​
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
​
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
​
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
​
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
​
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

​
Pipeline.ImageNixpacksBuildConfig

Nixpacks configuration for image builds
​
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
​
string | null
Nixpacks version to use(templateable)
​
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
​
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
​
string[] | null
Additional Nix packages to install(templateable)
​
string[] | null
Additional apt packages to install(templateable)
​
string[] | null
Additional Nix libraries to install(templateable)
​
string | null
Custom install command(templateable)
​
string | null
Custom build command(templateable)
​
string | null
Application start command(templateable)
​
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

​
Pipeline.ImageRailpackBuildConfig

Railpack configuration for image builds
​
enum
required
Build method — use Railpack auto-detectionAllowed values: railpack(templateable)
​
string | null
Railpack version to use(templateable)
​
string | null
Custom install command(templateable)
​
string | null
Custom build command(templateable)
​
string | null
Application start command(templateable)
​
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

​
Pipeline.AwsPermissions

IAM policies configuration for runner roles Used by EC2-backed steps to specify additional permissionsOne of: Pipeline.AwsPermissionsAttach, Pipeline.AwsPermissionsReplace.

​
Pipeline.InfrastructureType

Execution environment typeAllowed values:
  • ec2
  • ec2-spot

​
Pipeline.InstanceSize

Instance size can be a single string or array of stringsOne of: string, string[].

​
Pipeline.StorageConfig

Root volume storage configuration
​
enum
Volume typeAllowed values: gp3 | gp2 | io2 | io1(templateable)
​
integer | null
Volume size in GiB(format:int32; templateable)
​
integer | null
Provisioned IOPS(format:int32; templateable)
​
integer | null
Provisioned throughput in MiB/s(format:int32; templateable)

​
Pipeline.LambdaDockerfileBuildConfig

Dockerfile configuration for Lambda builds
​
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
​
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
​
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
​
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
​
string
required
Directory inside the built image containing the Lambda package contents(minLen:1; templateable)
​
integer | null
default:"52428800"
Maximum allowed zip size in bytes — build fails if exceeded(format:int32; templateable)

​
Pipeline.LambdaNixpacksBuildConfig

Nixpacks configuration for Lambda builds
​
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
​
string | null
Nixpacks version to use(templateable)
​
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
​
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
​
string[] | null
Additional Nix packages to install(templateable)
​
string[] | null
Additional apt packages to install(templateable)
​
string[] | null
Additional Nix libraries to install(templateable)
​
string | null
Custom install command(templateable)
​
string | null
Custom build command(templateable)
​
string | null
Application start command(templateable)
​
string
required
Directory inside the built image containing the Lambda package contents(minLen:1; templateable)
​
integer | null
default:"52428800"
Maximum allowed zip size in bytes — build fails if exceeded(format:int32; templateable)

​
Pipeline.StaticDockerfileBuildConfig

Dockerfile configuration for static builds
​
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
​
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
​
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
​
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
​
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

​
Pipeline.StaticNixpacksBuildConfig

Nixpacks configuration for static builds
​
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
​
string | null
Nixpacks version to use(templateable)
​
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
​
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
​
string[] | null
Additional Nix packages to install(templateable)
​
string[] | null
Additional apt packages to install(templateable)
​
string[] | null
Additional Nix libraries to install(templateable)
​
string | null
Custom install command(templateable)
​
string | null
Custom build command(templateable)
​
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

​
Pipeline.StaticRailpackBuildConfig

Railpack configuration for static builds
​
enum
required
Build method — use Railpack auto-detectionAllowed values: railpack(templateable)
​
string | null
Railpack version to use(templateable)
​
string | null
Custom install command(templateable)
​
string | null
Custom build command(templateable)
​
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

​
Pipeline.ParameterStoreEnvVar

Environment variable from AWS Parameter Store
​
Pipeline.ParameterStoreReferenceValue
required
Parameter Store referenceSee: Pipeline.ParameterStoreReferenceValue(templateable)

​
Pipeline.SecretsManagerEnvVar

Environment variable from AWS Secrets Manager
​
Pipeline.SecretsManagerReferenceValue
required
Secrets Manager referenceSee: Pipeline.SecretsManagerReferenceValue(templateable)

​
Pipeline.CacheFromConfig

Configuration for Docker layer cache source from ECR
​
string | null
Specific image digest to use for cache(templateable)
​
string | null
Specific image tag to use for cache(templateable)

​
Pipeline.AwsPermissionsAttach

IAM policies to attach alongside step default policies
​
string[]
required
AWS managed policy ARNs to attach alongside step default policies(templateable)

​
Pipeline.AwsPermissionsReplace

IAM policies to replace step default policies entirely
​
string[]
required
AWS managed policy ARNs to use instead of step default policies(templateable)

​
Pipeline.EbsVolumeType

EBS volume type for the runner root volumeAllowed values:
  • gp3
  • gp2
  • io2
  • io1

​
Pipeline.ParameterStoreReferenceValue

Parameter Store reference — shorthand string or object with optional version metadataOne of: string, Pipeline.ParameterStoreReference.

​
Pipeline.SecretsManagerReferenceValue

Secrets Manager reference — shorthand string or object with optional JSON key/version metadataOne of: string, Pipeline.SecretsManagerReference.

​
Pipeline.ParameterStoreReference

Parameter Store reference with optional version metadata
​
string
required
Parameter Store parameter name or path(templateable)
​
string | null
Parameter version number(templateable)

​
Pipeline.SecretsManagerReference

Secrets Manager reference with optional JSON key and version metadata
​
string
required
Secret name or ARN in Secrets Manager(templateable)
​
string | null
JSON key to extract from a JSON-structured secret(templateable)
​
string | null
Secret version ID or stage(templateable)