Struct aws_sdk_cloudformation::types::builders::StackBuilder

#[non_exhaustive]
pub struct StackBuilder { /* private fields */ }

A builder for Stack.

Implementations

impl StackBuilder

pub fn stack_id(self, input: impl Into<String>) -> Self

Unique identifier of the stack.

pub fn set_stack_id(self, input: Option<String>) -> Self

Unique identifier of the stack.

pub fn get_stack_id(&self) -> &Option<String>

Unique identifier of the stack.

pub fn stack_name(self, input: impl Into<String>) -> Self

The name associated with the stack.

This field is required.

pub fn set_stack_name(self, input: Option<String>) -> Self

The name associated with the stack.

pub fn get_stack_name(&self) -> &Option<String>

The name associated with the stack.

pub fn change_set_id(self, input: impl Into<String>) -> Self

The unique ID of the change set.

pub fn set_change_set_id(self, input: Option<String>) -> Self

The unique ID of the change set.

pub fn get_change_set_id(&self) -> &Option<String>

The unique ID of the change set.

pub fn description(self, input: impl Into<String>) -> Self

A user-defined description associated with the stack.

pub fn set_description(self, input: Option<String>) -> Self

A user-defined description associated with the stack.

pub fn get_description(&self) -> &Option<String>

A user-defined description associated with the stack.

pub fn parameters(self, input: Parameter) -> Self

Appends an item to parameters.

To override the contents of this collection use set_parameters.

A list of Parameter structures.

pub fn set_parameters(self, input: Option<Vec<Parameter>>) -> Self

A list of Parameter structures.

pub fn get_parameters(&self) -> &Option<Vec<Parameter>>

A list of Parameter structures.

pub fn creation_time(self, input: DateTime) -> Self

The time at which the stack was created.

This field is required.

pub fn set_creation_time(self, input: Option<DateTime>) -> Self

The time at which the stack was created.

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

The time at which the stack was created.

pub fn deletion_time(self, input: DateTime) -> Self

The time the stack was deleted.

pub fn set_deletion_time(self, input: Option<DateTime>) -> Self

The time the stack was deleted.

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

The time the stack was deleted.

pub fn last_updated_time(self, input: DateTime) -> Self

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

pub fn set_last_updated_time(self, input: Option<DateTime>) -> Self

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

pub fn get_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, input: RollbackConfiguration) -> Self

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

pub fn set_rollback_configuration( self, input: Option<RollbackConfiguration> ) -> Self

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

pub fn get_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, input: StackStatus) -> Self

Current status of the stack.

This field is required.

pub fn set_stack_status(self, input: Option<StackStatus>) -> Self

Current status of the stack.

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

Current status of the stack.

pub fn stack_status_reason(self, input: impl Into<String>) -> Self

Success/failure message associated with the stack status.

pub fn set_stack_status_reason(self, input: Option<String>) -> Self

Success/failure message associated with the stack status.

pub fn get_stack_status_reason(&self) -> &Option<String>

Success/failure message associated with the stack status.

pub fn disable_rollback(self, input: bool) -> Self

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

pub fn set_disable_rollback(self, input: Option<bool>) -> Self

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback.

• false: enable rollback.

pub fn get_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, input: impl Into<String>) -> Self

Appends an item to notification_arns.

To override the contents of this collection use set_notification_arns.

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

pub fn set_notification_arns(self, input: Option<Vec<String>>) -> Self

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

pub fn get_notification_arns(&self) -> &Option<Vec<String>>

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

pub fn timeout_in_minutes(self, input: i32) -> Self

The amount of time within which stack creation should complete.

pub fn set_timeout_in_minutes(self, input: Option<i32>) -> Self

The amount of time within which stack creation should complete.

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

The amount of time within which stack creation should complete.

pub fn capabilities(self, input: Capability) -> Self

Appends an item to capabilities.

To override the contents of this collection use set_capabilities.

The capabilities allowed in the stack.

pub fn set_capabilities(self, input: Option<Vec<Capability>>) -> Self

The capabilities allowed in the stack.

pub fn get_capabilities(&self) -> &Option<Vec<Capability>>

The capabilities allowed in the stack.

pub fn outputs(self, input: Output) -> Self

Appends an item to outputs.

To override the contents of this collection use set_outputs.

A list of output structures.

pub fn set_outputs(self, input: Option<Vec<Output>>) -> Self

A list of output structures.

pub fn get_outputs(&self) -> &Option<Vec<Output>>

A list of output structures.

pub fn role_arn(self, input: impl Into<String>) -> Self

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 set_role_arn(self, input: Option<String>) -> Self

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 get_role_arn(&self) -> &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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of Tags that specify information about the stack.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of Tags that specify information about the stack.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of Tags that specify information about the stack.

pub fn enable_termination_protection(self, input: bool) -> Self

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 set_enable_termination_protection(self, input: Option<bool>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_parent_id(self, input: Option<String>) -> Self

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 get_parent_id(&self) -> &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.

pub fn root_id(self, input: impl Into<String>) -> Self

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 set_root_id(self, input: Option<String>) -> Self

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 get_root_id(&self) -> &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.

pub fn drift_information(self, input: StackDriftInformation) -> Self

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 set_drift_information(self, input: Option<StackDriftInformation>) -> Self

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 get_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, input: bool) -> Self

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 set_retain_except_on_create(self, input: Option<bool>) -> Self

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 get_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, input: DetailedStatus) -> Self

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.

pub fn set_detailed_status(self, input: Option<DetailedStatus>) -> Self

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.

pub fn get_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.

pub fn build(self) -> Stack

Consumes the builder and constructs a Stack.

Trait Implementations

impl Clone for StackBuilder

fn clone(&self) -> StackBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackBuilder

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

Formats the value using the given formatter.

impl Default for StackBuilder

fn default() -> StackBuilder

Returns the “default value” for a type.

impl PartialEq for StackBuilder

fn eq(&self, other: &StackBuilder) -> 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 StackBuilder