Struct aws_sdk_cloudformation::types::StackInstance
source · #[non_exhaustive]pub struct StackInstance {
pub stack_set_id: Option<String>,
pub region: Option<String>,
pub account: Option<String>,
pub stack_id: Option<String>,
pub parameter_overrides: Option<Vec<Parameter>>,
pub status: Option<StackInstanceStatus>,
pub stack_instance_status: Option<StackInstanceComprehensiveStatus>,
pub status_reason: Option<String>,
pub organizational_unit_id: Option<String>,
pub drift_status: Option<StackDriftStatus>,
pub last_drift_check_timestamp: Option<DateTime>,
pub last_operation_id: Option<String>,
}
Expand description
An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the actual stack and the stack status.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stack_set_id: Option<String>
The name or unique ID of the stack set that the stack instance is associated with.
region: Option<String>
The name of the Amazon Web Services Region that the stack instance is associated with.
account: Option<String>
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
stack_id: Option<String>
The ID of the stack instance.
parameter_overrides: Option<Vec<Parameter>>
A list of parameters from the stack set template whose values have been overridden in this stack instance.
status: Option<StackInstanceStatus>
The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, to delete the stack instance, and then delete the stack manually.INOPERABLE
can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at theDetailedStatus
member in theStackInstanceSummary
member that is a peer to thisStatus
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
operation that failed or was stopped before the stack was created or updated.
-
-
CURRENT
: The stack is currently up to date with the stack set.
stack_instance_status: Option<StackInstanceComprehensiveStatus>
The detailed status of the stack instance.
status_reason: Option<String>
The explanation for the specific status code that's assigned to this stack instance.
organizational_unit_id: Option<String>
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
drift_status: Option<StackDriftStatus>
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set configuration. -
UNKNOWN
: This value is reserved for future use.
last_drift_check_timestamp: Option<DateTime>
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL
for any stack instance on which drift detection hasn't yet been performed.
last_operation_id: Option<String>
The last unique ID of a StackSet operation performed on a stack instance.
Implementations§
source§impl StackInstance
impl StackInstance
sourcepub fn stack_set_id(&self) -> Option<&str>
pub fn stack_set_id(&self) -> Option<&str>
The name or unique ID of the stack set that the stack instance is associated with.
sourcepub fn region(&self) -> Option<&str>
pub fn region(&self) -> Option<&str>
The name of the Amazon Web Services Region that the stack instance is associated with.
sourcepub fn account(&self) -> Option<&str>
pub fn account(&self) -> Option<&str>
[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.
sourcepub fn parameter_overrides(&self) -> &[Parameter]
pub fn parameter_overrides(&self) -> &[Parameter]
A list of parameters from the stack set template whose values have been overridden in this stack instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameter_overrides.is_none()
.
sourcepub fn status(&self) -> Option<&StackInstanceStatus>
pub fn status(&self) -> Option<&StackInstanceStatus>
The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE
: ADeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSet
operations. You might need to perform aDeleteStackInstances
operation, withRetainStacks
set totrue
, to delete the stack instance, and then delete the stack manually.INOPERABLE
can be returned here when the cause is a failed import. If it's due to a failed import, the operation can be retried once the failures are fixed. To see if this is due to a failed import, look at theDetailedStatus
member in theStackInstanceSummary
member that is a peer to thisStatus
member. -
OUTDATED
: The stack isn't currently up to date with the stack set because:-
The associated stack failed during a
CreateStackSet
orUpdateStackSet
operation. -
The stack was part of a
CreateStackSet
orUpdateStackSet
operation that failed or was stopped before the stack was created or updated.
-
-
CURRENT
: The stack is currently up to date with the stack set.
sourcepub fn stack_instance_status(&self) -> Option<&StackInstanceComprehensiveStatus>
pub fn stack_instance_status(&self) -> Option<&StackInstanceComprehensiveStatus>
The detailed status of the stack instance.
sourcepub fn status_reason(&self) -> Option<&str>
pub fn status_reason(&self) -> Option<&str>
The explanation for the specific status code that's assigned to this stack instance.
sourcepub fn organizational_unit_id(&self) -> Option<&str>
pub fn organizational_unit_id(&self) -> Option<&str>
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
sourcepub fn drift_status(&self) -> Option<&StackDriftStatus>
pub fn drift_status(&self) -> Option<&StackDriftStatus>
Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs.
-
DRIFTED
: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted. -
NOT_CHECKED
: CloudFormation hasn't checked if the stack instance differs from its expected stack set configuration. -
IN_SYNC
: The stack instance's actual configuration matches its expected stack set configuration. -
UNKNOWN
: This value is reserved for future use.
sourcepub fn last_drift_check_timestamp(&self) -> Option<&DateTime>
pub fn last_drift_check_timestamp(&self) -> Option<&DateTime>
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will be NULL
for any stack instance on which drift detection hasn't yet been performed.
sourcepub fn last_operation_id(&self) -> Option<&str>
pub fn last_operation_id(&self) -> Option<&str>
The last unique ID of a StackSet operation performed on a stack instance.
source§impl StackInstance
impl StackInstance
sourcepub fn builder() -> StackInstanceBuilder
pub fn builder() -> StackInstanceBuilder
Creates a new builder-style object to manufacture StackInstance
.
Trait Implementations§
source§impl Clone for StackInstance
impl Clone for StackInstance
source§fn clone(&self) -> StackInstance
fn clone(&self) -> StackInstance
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StackInstance
impl Debug for StackInstance
source§impl PartialEq for StackInstance
impl PartialEq for StackInstance
source§fn eq(&self, other: &StackInstance) -> bool
fn eq(&self, other: &StackInstance) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for StackInstance
Auto Trait Implementations§
impl Freeze for StackInstance
impl RefUnwindSafe for StackInstance
impl Send for StackInstance
impl Sync for StackInstance
impl Unpin for StackInstance
impl UnwindSafe for StackInstance
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more