aws_sdk_cloudformation/client/
rollback_stack.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RollbackStack`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_name(impl Into<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::set_stack_name):<br>required: **true**<br><p>The name that's associated with the stack.</p><br>
7    ///   - [`role_arn(impl Into<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.</p><br>
8    ///   - [`client_request_token(impl Into<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique identifier for this <code>RollbackStack</code> request.</p><br>
9    ///   - [`retain_except_on_create(bool)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::retain_except_on_create) / [`set_retain_except_on_create(Option<bool>)`](crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::set_retain_except_on_create):<br>required: **false**<br><p>When set to <code>true</code>, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of <code>Retain</code>.</p> <p>Default: <code>false</code></p><br>
10    /// - On success, responds with [`RollbackStackOutput`](crate::operation::rollback_stack::RollbackStackOutput) with field(s):
11    ///   - [`stack_id(Option<String>)`](crate::operation::rollback_stack::RollbackStackOutput::stack_id): <p>Unique identifier of the stack.</p>
12    /// - On failure, responds with [`SdkError<RollbackStackError>`](crate::operation::rollback_stack::RollbackStackError)
13    pub fn rollback_stack(&self) -> crate::operation::rollback_stack::builders::RollbackStackFluentBuilder {
14        crate::operation::rollback_stack::builders::RollbackStackFluentBuilder::new(self.handle.clone())
15    }
16}