Struct aws_sdk_cloudformation::types::Stack

#[non_exhaustive]
pub struct Stack {

    pub stack_id: Option<String>,
    pub stack_name: Option<String>,
    pub change_set_id: Option<String>,
    pub description: Option<String>,
    pub parameters: Option<Vec<Parameter>>,
    pub creation_time: Option<DateTime>,
    pub deletion_time: Option<DateTime>,
    pub last_updated_time: Option<DateTime>,
    pub rollback_configuration: Option<RollbackConfiguration>,
    pub stack_status: Option<StackStatus>,
    pub stack_status_reason: Option<String>,
    pub disable_rollback: Option<bool>,
    pub notification_arns: Option<Vec<String>>,
    pub timeout_in_minutes: Option<i32>,
    pub capabilities: Option<Vec<Capability>>,
    pub outputs: Option<Vec<Output>>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub enable_termination_protection: Option<bool>,
    pub parent_id: Option<String>,
    pub root_id: Option<String>,
    pub drift_information: Option<StackDriftInformation>,
    pub retain_except_on_create: Option<bool>,
    pub detailed_status: Option<DetailedStatus>,
}

The Stack data type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stack_id: Option<String>

Unique identifier of the stack.

stack_name: Option<String>

The name associated with the stack.

change_set_id: Option<String>

The unique ID of the change set.

description: Option<String>

A user-defined description associated with the stack.

parameters: Option<Vec<Parameter>>

A list of Parameter structures.

creation_time: Option<DateTime>

The time at which the stack was created.

deletion_time: Option<DateTime>

The time the stack was deleted.

last_updated_time: Option<DateTime>

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

rollback_configuration: Option<RollbackConfiguration>

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

stack_status: Option<StackStatus>

Current status of the stack.

stack_status_reason: Option<String>

Success/failure message associated with the stack status.

disable_rollback: Option<bool>

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

notification_arns: Option<Vec<String>>

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

timeout_in_minutes: Option<i32>

The amount of time within which stack creation should complete.

capabilities: Option<Vec<Capability>>

The capabilities allowed in the stack.

outputs: Option<Vec<Output>>

A list of output structures.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

tags: Option<Vec<Tag>>

A list of Tags that specify information about the stack.

enable_termination_protection: Option<bool>

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

parent_id: Option<String>

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

root_id: Option<String>

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

drift_information: Option<StackDriftInformation>

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

retain_except_on_create: Option<bool>

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

detailed_status: Option<DetailedStatus>

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

Implementations

impl Stack

pub fn stack_id(&self) -> Option<&str>

Unique identifier of the stack.

pub fn stack_name(&self) -> Option<&str>

The name associated with the stack.

pub fn change_set_id(&self) -> Option<&str>

The unique ID of the change set.

pub fn description(&self) -> Option<&str>

A user-defined description associated with the stack.

pub fn parameters(&self) -> &[Parameter]

A list of Parameter structures.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none().

pub fn creation_time(&self) -> Option<&DateTime>

The time at which the stack was created.

pub fn deletion_time(&self) -> Option<&DateTime>

The time the stack was deleted.

pub fn last_updated_time(&self) -> Option<&DateTime>

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

pub fn rollback_configuration(&self) -> Option<&RollbackConfiguration>

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

pub fn stack_status(&self) -> Option<&StackStatus>

Current status of the stack.

pub fn stack_status_reason(&self) -> Option<&str>

Success/failure message associated with the stack status.

pub fn disable_rollback(&self) -> Option<bool>

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

pub fn notification_arns(&self) -> &[String]

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .notification_arns.is_none().

pub fn timeout_in_minutes(&self) -> Option<i32>

The amount of time within which stack creation should complete.

pub fn capabilities(&self) -> &[Capability]

The capabilities allowed in the stack.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capabilities.is_none().

pub fn outputs(&self) -> &[Output]

A list of output structures.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .outputs.is_none().

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

pub fn tags(&self) -> &[Tag]

A list of Tags that specify information about the stack.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn enable_termination_protection(&self) -> Option<bool>

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and can't be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

pub fn parent_id(&self) -> Option<&str>

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

pub fn root_id(&self) -> Option<&str>

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the CloudFormation User Guide.

pub fn drift_information(&self) -> Option<&StackDriftInformation>

Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

pub fn retain_except_on_create(&self) -> Option<bool>

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

pub fn detailed_status(&self) -> Option<&DetailedStatus>

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

impl Stack

pub fn builder() -> StackBuilder

Creates a new builder-style object to manufacture Stack.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl PartialEq for Stack

fn eq(&self, other: &Stack) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Stack