Skip to main content

StackSettings

Struct StackSettings 

Source
pub struct StackSettings {
    pub deployment_model: Option<DeploymentModel>,
    pub domains: Option<DomainSettings>,
    pub heartbeats: Option<HeartbeatsMode>,
    pub network: Option<NetworkSettings>,
    pub telemetry: Option<TelemetryMode>,
    pub updates: Option<UpdatesMode>,
}
Expand description

User-customizable deployment settings specified at deploy time.

These settings are provided by the customer via CloudFormation parameters, Terraform attributes, CLI flags, or Helm values. They customize how the agent is deployed and what capabilities are enabled.

Key distinction: StackSettings is user-customizable, while ManagementConfig is platform-derived (from the Agent Manager’s ServiceAccount).

JSON schema
{
 "description": "User-customizable deployment settings specified at deploy time.\n\nThese settings are provided by the customer via CloudFormation parameters,\nTerraform attributes, CLI flags, or Helm values. They customize how the\nagent is deployed and what capabilities are enabled.\n\n**Key distinction**: StackSettings is user-customizable, while ManagementConfig\nis platform-derived (from the Agent Manager's ServiceAccount).",
 "type": "object",
 "properties": {
   "deploymentModel": {
     "description": "Deployment model: push (Agent Manager) or pull (Operator).\nDefault: Push for cloud platforms.\nKubernetes and Local platforms only support Pull.",
     "allOf": [
       {
         "$ref": "#/components/schemas/DeploymentModel"
       }
     ]
   },
   "domains": {
     "description": "Domain configuration (future).",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/DomainSettings"
           }
         ]
       }
     ]
   },
   "heartbeats": {
     "description": "How heartbeat health checks are handled.\n- off: No heartbeat permissions\n- on: Heartbeat enabled (default)",
     "allOf": [
       {
         "$ref": "#/components/schemas/HeartbeatsMode"
       }
     ]
   },
   "network": {
     "description": "Network configuration for the stack (VPC/VNet settings).\nIf `None`, an isolated VPC with NAT is auto-created when the stack has resources\nthat require networking (e.g., containers). Set explicitly to customize:\n`UseDefault` for the provider's default network (fast, dev/test only),\n`Create` for an isolated VPC with managed NAT (production), or `ByoVpc*`\nto reference an existing customer-managed VPC.",
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/NetworkSettings"
           }
         ]
       }
     ]
   },
   "telemetry": {
     "description": "How telemetry (logs, metrics, traces) is handled.\n- off: No telemetry permissions\n- auto: Telemetry flows automatically (default)\n- approval-required: Telemetry waits for explicit approval",
     "allOf": [
       {
         "$ref": "#/components/schemas/TelemetryMode"
       }
     ]
   },
   "updates": {
     "description": "How updates are delivered.\n- auto: Updates deploy automatically (default)\n- approval-required: Updates wait for explicit approval",
     "allOf": [
       {
         "$ref": "#/components/schemas/UpdatesMode"
       }
     ]
   }
 }
}

Fields§

§deployment_model: Option<DeploymentModel>

Deployment model: push (Agent Manager) or pull (Operator). Default: Push for cloud platforms. Kubernetes and Local platforms only support Pull.

§domains: Option<DomainSettings>

Domain configuration (future).

§heartbeats: Option<HeartbeatsMode>

How heartbeat health checks are handled.

  • off: No heartbeat permissions
  • on: Heartbeat enabled (default)
§network: Option<NetworkSettings>

Network configuration for the stack (VPC/VNet settings). If None, an isolated VPC with NAT is auto-created when the stack has resources that require networking (e.g., containers). Set explicitly to customize: UseDefault for the provider’s default network (fast, dev/test only), Create for an isolated VPC with managed NAT (production), or ByoVpc* to reference an existing customer-managed VPC.

§telemetry: Option<TelemetryMode>

How telemetry (logs, metrics, traces) is handled.

  • off: No telemetry permissions
  • auto: Telemetry flows automatically (default)
  • approval-required: Telemetry waits for explicit approval
§updates: Option<UpdatesMode>

How updates are delivered.

  • auto: Updates deploy automatically (default)
  • approval-required: Updates wait for explicit approval

Implementations§

Trait Implementations§

Source§

impl Clone for StackSettings

Source§

fn clone(&self) -> StackSettings

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 StackSettings

Source§

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

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

impl Default for StackSettings

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StackSettings

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<&StackSettings> for StackSettings

Source§

fn from(value: &StackSettings) -> Self

Converts to this type from the input type.
Source§

impl From<StackSettings> for StackSettings

Source§

fn from(value: StackSettings) -> Self

Converts to this type from the input type.
Source§

impl Serialize for StackSettings

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<StackSettings> for StackSettings

Source§

type Error = ConversionError

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

fn try_from(value: StackSettings) -> 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>,