Expand description
Types used as operation parameters and responses.
Modules§
Structs§
- Acquire
Request AcquireRequest- Acquire
Response AcquireResponse- Acquired
Deployment Response AcquiredDeploymentResponse- Alien
Error - Canonical error container that provides a structured way to represent errors with rich metadata including error codes, human-readable messages, context, and chaining capabilities for error propagation.
- Alien
Error Code - A unique identifier for the type of error.
- Alien
Error Message - Human-readable error message.
- AwsCustom
Certificate Config AwsCustomCertificateConfig- AwsEnvironment
Info - AWS-specific environment information
- AwsPlatform
Permission - AWS-specific platform permission configuration
- Azure
Custom Certificate Config AzureCustomCertificateConfig- Azure
Environment Info - Azure-specific environment information
- Azure
Platform Permission - Azure-specific platform permission configuration
- Base
Resource - Resource that can hold any resource type in the Alien system. All resources share common ‘type’ and ‘id’ fields with additional type-specific properties.
- Base
Resource Outputs - Resource outputs that can hold output data for any resource type in the Alien system. All resource outputs share a common ‘type’ field with additional type-specific output properties.
- Binding
Configuration AwsBinding Spec - Generic binding configuration for permissions
- Binding
Configuration AwsBinding Spec Resource - AWS-specific binding specification
- Binding
Configuration AwsBinding Spec Stack - AWS-specific binding specification
- Binding
Configuration Azure Binding Spec - Generic binding configuration for permissions
- Binding
Configuration Azure Binding Spec Resource - Azure-specific binding specification
- Binding
Configuration Azure Binding Spec Stack - Azure-specific binding specification
- Binding
Configuration GcpBinding Spec - Generic binding configuration for permissions
- Binding
Configuration GcpBinding Spec Resource - GCP-specific binding specification
- Binding
Configuration GcpBinding Spec Stack - GCP-specific binding specification
- Commands
Info CommandsInfo- Create
Deployment Group Request CreateDeploymentGroupRequest- Create
Deployment Request CreateDeploymentRequest- Create
Deployment Response CreateDeploymentResponse- Create
Release Request CreateReleaseRequest- Create
Token Response CreateTokenResponse- Custom
Certificate Config - Platform-specific certificate references for custom domains.
- Custom
Domain Config - Custom domain configuration for a single resource.
- Deployment
Group Minimal DeploymentGroupMinimal- Deployment
Group Response DeploymentGroupResponse- Deployment
Info Response DeploymentInfoResponse- Deployment
Response DeploymentResponse- Deployment
State - Deployment state
- Domain
Settings - Domain configuration for the stack.
- GcpCondition
- GCP IAM condition
- GcpCustom
Certificate Config GcpCustomCertificateConfig- GcpEnvironment
Info - GCP-specific environment information
- GcpPlatform
Permission - GCP-specific platform permission configuration
- GitMetadata
GitMetadata- GitMetadata
Response GitMetadataResponse- Health
Response HealthResponse- Initialize
Request InitializeRequest- Initialize
Response InitializeResponse- List
Deployment Groups Response ListDeploymentGroupsResponse- List
Deployments Response ListDeploymentsResponse- Local
Environment Info - Local platform environment information
- Operator
Sync Request OperatorSyncRequest- Operator
Sync Response OperatorSyncResponse- Permission
Grant - Grant permissions for a specific cloud platform
- Permission
Profile - Permission profile that maps resources to permission sets Key can be “*” for all resources or resource name for specific resource
- Permission
Set - A permission set that can be applied across different cloud platforms
- Permissions
Config - Combined permissions configuration that contains both profiles and management
- Platform
Permissions - Platform-specific permission configurations
- Reconcile
Request ReconcileRequest- Reconcile
Response ReconcileResponse- Release
Info - Release metadata
- Release
Request ReleaseRequest- Release
Response ReleaseResponse- Resolve
Credentials Request ResolveCredentialsRequest- Resolve
Credentials Response ResolveCredentialsResponse- Resource
Entry ResourceEntry- Resource
Ref - New ResourceRef that works with any resource type. This can eventually replace the enum-based ResourceRef for full extensibility.
- Resource
Type - Resource type identifier that determines the specific kind of resource. This field is used for polymorphic deserialization and resource-specific behavior.
- Runtime
Metadata - Runtime metadata for deployment
- Scope
Info ScopeInfo- Stack
- A bag of resources, unaware of any cloud.
- Stack
ByPlatform - The release API accepts stacks keyed by platform. Only one platform stack needs to be present.
- Stack
Resource State - Represents the state of a single resource within the stack for a specific platform.
- Stack
Settings - User-customizable deployment settings specified at deploy time.
- Stack
State - Represents the collective state of all resources in a stack, including platform and pending actions.
- Test
Environment Info - Test platform environment information (mock)
- Whoami
Response WhoamiResponse
Enums§
- Deployment
Model - Deployment model: how updates are delivered to the remote environment.
- Deployment
Status - Deployment status in the deployment lifecycle
- Environment
Info - Platform-specific environment information
- Environment
Info Variant0 Platform EnvironmentInfoVariant0Platform- Environment
Info Variant1 Platform EnvironmentInfoVariant1Platform- Environment
Info Variant2 Platform EnvironmentInfoVariant2Platform- Environment
Info Variant3 Platform EnvironmentInfoVariant3Platform- Environment
Info Variant4 Platform EnvironmentInfoVariant4Platform- Heartbeats
Mode - How heartbeat health checks are handled.
- Management
Permissions - Management permissions configuration for stack management access
- Network
Settings - Network configuration for the stack.
- Permission
SetReference - Reference to a permission set - either by name or inline definition
- Platform
- Represents the target cloud platform.
- Resource
Lifecycle - Describes the lifecycle of a resource within a stack, determining how it’s managed and deployed.
- Resource
Status - Represents the high-level status of a resource during its lifecycle.
- Telemetry
Mode - How telemetry (logs, metrics, traces) is handled.
- Updates
Mode - How updates are delivered to the agent.