Skip to main content

Legend

Deploy

Deployment configuration for this module

ModuleDeployment

Deployment configuration — discriminated by deployment typeDiscriminated union. The type field selects which schema applies.

AwsStaticModuleDeployment

AWS static site deployment configuration
enum
required
Deployment type discriminatorAllowed values: aws:static
AwsStaticDeploymentInfrastructure
required
Infrastructure resources required by the deploymentSee: AwsStaticDeploymentInfrastructure
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal.See: InputProperty
AwsStaticDeploymentDefinition
required
Per-deploy definition. Templateable — supports both module.input and deploy.input references inside string fields.See: AwsStaticDeploymentDefinition(templateable)

Ec2ModuleDeployment

AWS EC2 deployment configuration. In-place only: instances are never replaced; the module-provided SSM document performs the whole per-instance deploy and it…
enum
required
Deployment type discriminatorAllowed values: aws:ec2
Pipeline.GitSource
See: Pipeline.GitSource(templateable)
Ec2DeploymentInfrastructure
required
Infrastructure resources required by the deployment.See: Ec2DeploymentInfrastructure
EcsDeployConcurrency
Concurrency policy — controls how simultaneous deploy requests are handled.See: EcsDeployConcurrency
Ec2DeploymentStrategyConfig
Rolling in-place deployment strategy. Its rollout controls map to SSM SendCommand MaxConcurrency / MaxErrors.See: Ec2DeploymentStrategyConfig(templateable)
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal.See: InputProperty
Ec2DeploymentDefinition
required
Per-deploy definition. Templateable — supports both module.input and deploy.input references inside string fields.See: Ec2DeploymentDefinition(templateable)

LambdaModuleDeployment

AWS Lambda deployment configuration. v1 supports UpdateFunctionCode + PublishVersion + UpdateAlias. Pre/post deploy hooks and weighted- routing alias shifts…
enum
required
Deployment type discriminatorAllowed values: aws:lambda
LambdaDeploymentInfrastructure
required
Infrastructure resources required by the deployment.See: LambdaDeploymentInfrastructure
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal.See: InputProperty
LambdaDeploymentDefinition
required
Per-deploy definition. Templateable — supports both module.input and deploy.input references inside string fields.See: LambdaDeploymentDefinition(templateable)
LambdaFunctionConfiguration
Per-deploy function-configuration overrides applied via UpdateFunctionConfiguration before the new code is published.See: LambdaFunctionConfiguration(templateable)

AwsStaticDeploymentDefinition

Per-deploy definition for AWS static deployments. The deploy manager promotes the resolved s3_directory to the active KVS key and (optionally) issues a b…
string
required
S3 directory (version prefix) to promote to active.(minLen:1; templateable)
string[] | null
CloudFront cache invalidation paths to issue across every distribution after the KVS write succeeds. Runs in the background — the deploy is marked complete o…(templateable)
integer | null
Number of latest successful deploys to keep in S3. Older S3 directories are pruned in the background after a successful deploy. Omit or set to 0 to disable p…(format:int32,min:0; templateable)

AwsStaticDeploymentInfrastructure

Infrastructure resources required for AWS static site deployment.
string
required
CloudFront KeyValueStore ARN that holds the active version pointer.(minLen:1; templateable)
string[]
required
CloudFront distribution ARNs that share this origin/KVS.(minItems:1; templateable)
string
required
AWS region of the S3 hosting bucket.(minLen:1; templateable)
string
required
S3 bucket name that hosts the versioned build directories.(minLen:1; templateable)

Ec2DeploymentDefinition

Per-deploy EC2 definition — discriminated by runtime.Discriminated union. The runtime field selects which schema applies.

Ec2DeploymentInfrastructure

Infrastructure resources required for an AWS EC2 deployment. Not provisioned by the deploy manager — must already exist (created by the compute/ec2_service
string
required
Name of the Auto Scaling Group whose in-service instances the deploy targets. For container deploys the module’s SSM deploy document is derived from this nam…(minLen:1; templateable)
string
required
AWS region of the Auto Scaling Group and SSM document.(minLen:1; templateable)
string
required
Ravion AWS account ID (awsact_…, as selected from $values:ravion/aws_accounts) that owns the Auto Scaling Group — not the raw AWS account number. Unlike…(minLen:1; templateable)
string | null
CloudWatch log group receiving application stdout and stderr from the EC2 instances. The deploy manager combines this with the deployment and instance IDs to…(templateable)
string | null
ARN of the service target group when the service is attached to a load balancer. Informational for the deploy manager (the SSM document owns drain/re-registe…(templateable)

Ec2DeploymentStrategyConfig

Rolling in-place deployment strategy for EC2 instances. The rollout controls map 1:1 to SSM SendCommand’s MaxConcurrency / MaxErrors semantics — values are a…
enum
required
Deployment strategy. EC2 deployments currently support rolling in-place updates only.Allowed values: rolling(templateable)
string | null
How many instances run the deploy document at once. SSM SendCommand MaxConcurrency semantics.(templateable)
string | null
How many per-instance failures are tolerated before SSM stops sending the document to further instances. SSM SendCommand MaxErrors semantics.(templateable)

LambdaDeploymentDefinition

Per-deploy Lambda definition — discriminated by package_type.Discriminated union. The package_type field selects which schema applies.

LambdaDeploymentInfrastructure

Infrastructure resources required for AWS Lambda deployment.
string
required
Full ARN of the Lambda function the deploy targets.(minLen:1; templateable)
string
required
AWS region of the function. Mirrors aws_static_module_deployment’s s3_region — needed because Lambda’s regional endpoint is the only thing the workflow c…(minLen:1; templateable)
string | null
Alias the deploy flips after publishing the new function version.(templateable)
string | null
S3 bucket the build step uploaded the zip artifact into. Optional — captured into the deploy snapshot for audit even when the deploy itself targets an Image-…(templateable)

LambdaFunctionConfiguration

AWS Lambda function configuration — every field optional, applied as a partial update via UpdateFunctionConfiguration. Fields the user omits are left untou…
string | null
IAM execution role ARN.(templateable)
string | null
Handler entrypoint (Zip only — ignored for Image).(templateable)
string | null
Lambda runtime (Zip only — ignored for Image).(templateable)
integer | null
Memory size in MiB. 128–10240.(format:int32,min:128,max:10240; templateable)
integer | null
Wall-clock timeout in seconds. 1–900.(format:int32,min:1,max:900; templateable)
string | null
Function description shown in the AWS console.(templateable)
enum[x86_64,arm64][] | null
CPU architectures — exactly one of x86_64 or arm64.(templateable)
LambdaEnvironment
Environment variables applied to the function.See: LambdaEnvironment(templateable)
LambdaVpcConfig
VPC configuration. Setting empty arrays disconnects the function from the VPC.See: LambdaVpcConfig(templateable)
string[] | null
Lambda layer ARNs (versioned, e.g.(templateable)
LambdaEphemeralStorage
Ephemeral /tmp storage size.See: LambdaEphemeralStorage(templateable)
LambdaTracingConfig
X-Ray tracing mode.See: LambdaTracingConfig(templateable)
string | null
Customer-managed KMS key ARN for environment variable encryption.(templateable)
LambdaDeadLetterConfig
Dead-letter destination for async invocations.See: LambdaDeadLetterConfig(templateable)
LambdaFileSystemConfig[] | null
EFS file systems attached to the function.See: LambdaFileSystemConfig(templateable)
LambdaSnapStart
SnapStart configuration. Java-only on AWS today, but the field is forwarded as-is to Lambda.See: LambdaSnapStart(templateable)
LambdaLoggingConfig
CloudWatch logging configuration.See: LambdaLoggingConfig(templateable)
LambdaImageConfig
Image overrides — image-packaged functions only.See: LambdaImageConfig(templateable)

Ec2ContainerDeploymentDefinition

Container-runtime EC2 deploy definition. The image must already exist (pushed by the upstream build step’s ecr destination, or supplied by the user for pre…
enum
required
Definition type discriminator.Allowed values: container(templateable)
string
required
Full image URI to deploy. Prefer a digest-qualified URI for reproducibility. Templateable — typically combines the repository URL with a deploy input or refe…(minLen:1; templateable)

Ec2ManualDeploymentDefinition

Manual-runtime EC2 deploy definition. The deploy manager sends these shell commands to every in-service instance through the module-provided deploy document,…
enum
required
Definition type discriminator.Allowed values: manual(templateable)
string[]
required
Shell commands run in order on each instance, as root. A non-zero exit fails the deploy on that instance.(minItems:1; templateable)
string | null
Long-running foreground command started after the release commands succeed. The deploy manager forwards it to the module-provided deploy document so it is ca…(templateable)

LambdaImageDefinition

Image-packaged Lambda deploy definition. The image must already exist in ECR (typically pushed by the upstream build step’s ecr destination).
enum
required
Definition type discriminator.Allowed values: image(templateable)
string
required
Full ECR image URI. Prefer <repo>@sha256:<digest> form for reproducibility — Lambda resolves a mutable tag at deploy time and silently pins it, but the dep…(minLen:1; templateable)

LambdaZipDefinition

Zip-packaged Lambda deploy definition. The code object must already exist in S3 (typically uploaded by the upstream build step’s s3-zip destination).
enum
required
Definition type discriminator.Allowed values: zip(templateable)
string
required
S3 key the build step uploaded into.(minLen:1; templateable)

LambdaDeadLetterConfig

Dead-letter destination for async invocations.
string | null
SQS queue ARN or SNS topic ARN.(templateable)

LambdaEnvironment

Lambda function environment block. Mirrors AWS Lambda’s Environment shape — a single variables map of string → string.
map<string,string> | null
Environment variables applied to the function. Replaces the existing variable set on AWS — the API doesn’t merge.(templateable)

LambdaEphemeralStorage

Function-level ephemeral storage (/tmp) size in MiB.
integer
required
Size in MiB. 512–10240.(format:int32,min:512,max:10240; templateable)

LambdaFileSystemConfig

EFS file system attached to the function.
string
required
EFS access point ARN.(templateable)
string
required
Mount path inside the container — must start with /mnt/.(templateable)

LambdaImageConfig

Container image configuration overrides — image-packaged functions only.
string[] | null
Override the image’s CMD.(templateable)
string[] | null
Override the image’s ENTRYPOINT.(templateable)
string | null
Override the image’s WORKDIR.(templateable)

LambdaLoggingConfig

Function logging configuration (CloudWatch destination + log levels).
enum | null
Format the logs are emitted in.Allowed values: JSON | Text(templateable)
enum | null
Application log level — only valid when log_format is JSON.Allowed values: TRACE | DEBUG | INFO | WARN | ERROR | FATAL(templateable)
enum | null
System log level — only valid when log_format is JSON.Allowed values: DEBUG | INFO | WARN(templateable)
string | null
Destination CloudWatch log group.(templateable)

LambdaSnapStart

SnapStart configuration.
enum
required
When to take the snapshot. None disables SnapStart; PublishedVersions snapshots each PublishVersion call.Allowed values: None | PublishedVersions(templateable)

LambdaTracingConfig

AWS X-Ray tracing configuration.
enum
required
Active samples + traces requests; PassThrough only propagates an upstream sampling decision.Allowed values: Active | PassThrough(templateable)

LambdaVpcConfig

VPC configuration for a Lambda function.
string[] | null
Subnet IDs the function’s ENIs are placed into.(templateable)
string[] | null
Security group IDs attached to the function’s ENIs.(templateable)
boolean | null
Whether the function gets dual-stack IPv6 networking.(templateable)