Skip to main content

StackResourceState

Struct StackResourceState 

Source
pub struct StackResourceState {
Show 13 fields pub config: BaseResource, pub dependencies: Vec<ResourceRef>, pub error: Option<AlienError>, pub internal: Option<Value>, pub is_externally_provisioned: Option<bool>, pub last_failed_state: Option<Value>, pub lifecycle: Option<ResourceLifecycle>, pub outputs: Option<BaseResourceOutputs>, pub previous_config: Option<BaseResource>, pub remote_binding_params: Option<Value>, pub retry_attempt: Option<i32>, pub status: ResourceStatus, pub type_: String,
}
Expand description

Represents the state of a single resource within the stack for a specific platform.

JSON schema
{
 "description": "Represents the state of a single resource within the stack for a specific platform.",
 "type": "object",
 "required": [
   "config",
   "status",
   "type"
 ],
 "properties": {
   "_internal": {
     "description": "The platform-specific resource controller that manages this resource's lifecycle.\nThis is None when the resource status is Pending.\nStored as JSON to make the struct serializable and movable to alien-core."
   },
   "config": {
     "description": "The current resource configuration.",
     "allOf": [
       {
         "$ref": "#/components/schemas/BaseResource"
       }
     ]
   },
   "dependencies": {
     "description": "Complete list of dependencies for this resource, including infrastructure dependencies.\nThis preserves the full dependency information from the stack definition.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/ResourceRef"
     }
   },
   "error": {
     "description": "Stores the last error encountered during a failed step transition.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/AlienError"
           }
         ]
       }
     ]
   },
   "isExternallyProvisioned": {
     "description": "True if the resource was provisioned by an external system (e.g., CloudFormation).\nDefaults to false, indicating dynamic provisioning by the executor.",
     "type": "boolean"
   },
   "lastFailedState": {
     "description": "Stores the controller state that failed, used for manual retry operations.\nThis allows resuming from the exact point where the failure occurred.\nStored as JSON to make the struct serializable and movable to alien-core."
   },
   "lifecycle": {
     "description": "The lifecycle of the resource (Frozen, Live, LiveOnSetup).\nDefaults to Live if not specified.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/ResourceLifecycle"
           }
         ]
       }
     ]
   },
   "outputs": {
     "description": "Outputs generated by the resource (e.g., ARN, URL, Bucket Name).",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BaseResourceOutputs"
           }
         ]
       }
     ]
   },
   "previousConfig": {
     "description": "The previous resource configuration during updates.\nThis is set when an update is initiated and cleared when the update completes or fails.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/BaseResource"
           }
         ]
       }
     ]
   },
   "remoteBindingParams": {
     "description": "Binding parameters for remote access.\nOnly populated when the resource has `remote_access: true` in its ResourceEntry.\nThis is the JSON serialization of the binding configuration (e.g., StorageBinding, VaultBinding).\nPopulated by controllers during provisioning using get_binding_params()."
   },
   "retryAttempt": {
     "description": "Tracks consecutive retry attempts for the current state transition.",
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "status": {
     "description": "High-level status derived from the internal state.",
     "allOf": [
       {
         "$ref": "#/components/schemas/ResourceStatus"
       }
     ]
   },
   "type": {
     "description": "The high-level type of the resource (e.g., Function::RESOURCE_TYPE, Storage::RESOURCE_TYPE).",
     "type": "string"
   }
 }
}

Fields§

§config: BaseResource

The current resource configuration.

§dependencies: Vec<ResourceRef>

Complete list of dependencies for this resource, including infrastructure dependencies. This preserves the full dependency information from the stack definition.

§error: Option<AlienError>

Stores the last error encountered during a failed step transition.

§internal: Option<Value>

The platform-specific resource controller that manages this resource’s lifecycle. This is None when the resource status is Pending. Stored as JSON to make the struct serializable and movable to alien-core.

§is_externally_provisioned: Option<bool>

True if the resource was provisioned by an external system (e.g., CloudFormation). Defaults to false, indicating dynamic provisioning by the executor.

§last_failed_state: Option<Value>

Stores the controller state that failed, used for manual retry operations. This allows resuming from the exact point where the failure occurred. Stored as JSON to make the struct serializable and movable to alien-core.

§lifecycle: Option<ResourceLifecycle>

The lifecycle of the resource (Frozen, Live, LiveOnSetup). Defaults to Live if not specified.

§outputs: Option<BaseResourceOutputs>

Outputs generated by the resource (e.g., ARN, URL, Bucket Name).

§previous_config: Option<BaseResource>

The previous resource configuration during updates. This is set when an update is initiated and cleared when the update completes or fails.

§remote_binding_params: Option<Value>

Binding parameters for remote access. Only populated when the resource has remote_access: true in its ResourceEntry. This is the JSON serialization of the binding configuration (e.g., StorageBinding, VaultBinding). Populated by controllers during provisioning using get_binding_params().

§retry_attempt: Option<i32>

Tracks consecutive retry attempts for the current state transition.

§status: ResourceStatus

High-level status derived from the internal state.

§type_: String

The high-level type of the resource (e.g., Function::RESOURCE_TYPE, Storage::RESOURCE_TYPE).

Implementations§

Trait Implementations§

Source§

impl Clone for StackResourceState

Source§

fn clone(&self) -> StackResourceState

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StackResourceState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for StackResourceState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&StackResourceState> for StackResourceState

Source§

fn from(value: &StackResourceState) -> Self

Converts to this type from the input type.
Source§

impl From<StackResourceState> for StackResourceState

Source§

fn from(value: StackResourceState) -> Self

Converts to this type from the input type.
Source§

impl Serialize for StackResourceState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<StackResourceState> for StackResourceState

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: StackResourceState) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,