Struct cloudformatious::DeleteStackInput

pub struct DeleteStackInput {
    pub client_request_token: Option<String>,
    pub retain_resources: Option<Vec<String>>,
    pub role_arn: Option<String>,
    pub stack_name: String,
}

The input for the delete_stack operation.

You can create a delete stack input via the new associated function. Setters are also available to make constructing sparse inputs more ergonomic.

use cloudformatious::DeleteStackInput;

let config = aws_config::load_from_env().await;
let client = cloudformatious::Client::new(&config);
let input = DeleteStackInput::new("my-stack")
    .set_client_request_token("hello")
    .set_retain_resources(["MyResource"])
    .set_role_arn("arn:foo");
client.delete_stack(input).await?;
// ...

Fields

client_request_token: Option<String>

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you’re not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

retain_resources: Option<Vec<String>>

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

role_arn: Option<String>

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role’s credentials to make calls on your behalf.

If you don’t specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

stack_name: String

The name or the unique stack ID that is associated with the stack.

Implementations

impl DeleteStackInput

pub fn new(stack_name: impl Into<String>) -> Self

Construct an input for the given stack_name and template_source.

pub fn set_client_request_token( self, client_request_token: impl Into<String> ) -> Self

Set the value for client_request_token.

Note: this consumes and returns self for chaining.

pub fn set_retain_resources<I, S>(self, retain_resources: I) -> Self

where I: Into<Vec<S>>, S: Into<String>,

Set the value for client_request_token.

Note: this consumes and returns self for chaining.

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

Set the value for role_arn.

Note: this consumes and returns self for chaining.