1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
use std::{fmt, future::Future, pin::Pin, task};
use async_stream::try_stream;
use aws_sdk_cloudformation::{
error::{ProvideErrorMetadata, SdkError},
operation::{
delete_stack::builders::DeleteStackFluentBuilder, describe_stacks::DescribeStacksError,
},
};
use chrono::Utc;
use futures_util::{Stream, TryStreamExt};
use crate::{
stack::{StackOperation, StackOperationError, StackOperationStatus},
StackEvent, StackFailure, StackStatus, StackWarning,
};
/// The input for the `delete_stack` operation.
///
/// You can create a delete stack input via the [`new`](Self::new) associated function. Setters are
/// also available to make constructing sparse inputs more ergonomic.
///
/// ```no_run
/// use cloudformatious::DeleteStackInput;
///
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// 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?;
/// // ...
/// # Ok(())
/// # }
/// ```
#[allow(clippy::module_name_repetitions)]
pub struct DeleteStackInput {
/// 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 `StackEvent`s 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`.
pub client_request_token: Option<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.
pub retain_resources: Option<Vec<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.
pub role_arn: Option<String>,
/// The name or the unique stack ID that is associated with the stack.
pub stack_name: String,
}
impl DeleteStackInput {
/// Construct an input for the given `stack_name` and `template_source`.
pub fn new(stack_name: impl Into<String>) -> Self {
Self {
stack_name: stack_name.into(),
client_request_token: None,
retain_resources: None,
role_arn: None,
}
}
/// Set the value for `client_request_token`.
///
/// **Note:** this consumes and returns `self` for chaining.
#[must_use]
pub fn set_client_request_token(mut self, client_request_token: impl Into<String>) -> Self {
self.client_request_token = Some(client_request_token.into());
self
}
/// Set the value for `client_request_token`.
///
/// **Note:** this consumes and returns `self` for chaining.
#[must_use]
pub fn set_retain_resources<I, S>(mut self, retain_resources: I) -> Self
where
I: Into<Vec<S>>,
S: Into<String>,
{
self.retain_resources = Some(
retain_resources
.into()
.into_iter()
.map(Into::into)
.collect(),
);
self
}
/// Set the value for `role_arn`.
///
/// **Note:** this consumes and returns `self` for chaining.
#[must_use]
pub fn set_role_arn(mut self, role_arn: impl Into<String>) -> Self {
self.role_arn = Some(role_arn.into());
self
}
fn configure(self, input: DeleteStackFluentBuilder) -> DeleteStackFluentBuilder {
input
.set_client_request_token(self.client_request_token)
.set_retain_resources(self.retain_resources)
.set_role_arn(self.role_arn)
.stack_name(self.stack_name)
}
}
/// Errors emitted by a `delete_stack` operation.
#[derive(Debug)]
#[allow(clippy::module_name_repetitions)]
pub enum DeleteStackError {
/// A CloudFormation API error occurred.
///
/// This is likely to be due to invalid input parameters or missing CloudFormation permissions.
/// The inner error should have a descriptive message.
///
/// **Note:** the inner error will always be some variant of [`SdkError`], but since they are
/// generic over the type of service errors we either need a variant per API used, or `Box`. If
/// you do need to programmatically match a particular API error you can use [`Box::downcast`].
CloudFormationApi(Box<dyn std::error::Error>),
/// The delete stack operation failed.
Failure(StackFailure),
/// The delete stack operation succeeded with warnings.
Warning(StackWarning),
}
impl DeleteStackError {
fn from_sdk_error<E: std::error::Error + 'static>(error: SdkError<E>) -> Self {
Self::CloudFormationApi(error.into())
}
}
impl fmt::Display for DeleteStackError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::CloudFormationApi(error) => {
write!(f, "CloudFormation API error: {error}")
}
Self::Failure(failure) => write!(f, "{failure}"),
Self::Warning(warning) => write!(f, "{warning}"),
}
}
}
impl std::error::Error for DeleteStackError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Self::CloudFormationApi(error) => Some(error.as_ref()),
Self::Failure { .. } | Self::Warning { .. } => None,
}
}
}
/// An ongoing `delete_stack` operation.
///
/// This implements `Future`, which will simply wait for the operation to conclude. If you want to
/// observe progress, see [`DeleteStack::events`].
pub struct DeleteStack<'client> {
event_stream: Pin<Box<dyn Stream<Item = Result<StackEvent, DeleteStackError>> + 'client>>,
output: Option<Result<(), DeleteStackError>>,
}
impl<'client> DeleteStack<'client> {
pub(crate) fn new(
client: &'client aws_sdk_cloudformation::Client,
input: DeleteStackInput,
) -> Self {
let event_stream = try_stream! {
let Some(stack_id) = (describe_stack_id(client, input.stack_name.clone()).await?) else {
return;
};
let started_at = Utc::now();
input.configure(client.delete_stack()).send()
.await
.map_err(DeleteStackError::from_sdk_error)?;
let mut operation =
StackOperation::new(client, stack_id, started_at, check_operation_status);
while let Some(event) = operation
.try_next()
.await
.map_err(DeleteStackError::from_sdk_error)?
{
yield event;
}
match operation.verify() {
Ok(()) => {}
Err(StackOperationError::Failure(failure)) => {
Err(DeleteStackError::Failure(failure))?;
unreachable!()
}
Err(StackOperationError::Warning(warning)) => {
Err(DeleteStackError::Warning(warning))?;
unreachable!()
}
};
};
Self {
event_stream: Box::pin(event_stream),
output: None,
}
}
/// Get a `Stream` of `StackEvent`s.
pub fn events(&mut self) -> DeleteStackEvents<'client, '_> {
DeleteStackEvents(self)
}
fn poll_next_internal(&mut self, ctx: &mut task::Context) -> task::Poll<Option<StackEvent>> {
match self.event_stream.as_mut().poll_next(ctx) {
task::Poll::Pending => task::Poll::Pending,
task::Poll::Ready(None) => {
self.output.get_or_insert(Ok(()));
task::Poll::Ready(None)
}
task::Poll::Ready(Some(Ok(event))) => task::Poll::Ready(Some(event)),
task::Poll::Ready(Some(Err(error))) => {
self.output.replace(Err(error));
task::Poll::Ready(None)
}
}
}
}
impl Future for DeleteStack<'_> {
type Output = Result<(), DeleteStackError>;
fn poll(mut self: Pin<&mut Self>, ctx: &mut task::Context) -> task::Poll<Self::Output> {
loop {
match self.poll_next_internal(ctx) {
task::Poll::Pending => return task::Poll::Pending,
task::Poll::Ready(None) => {
return task::Poll::Ready(
self.output
.take()
.expect("end of stream without err or output"),
)
}
task::Poll::Ready(Some(_)) => continue,
}
}
}
}
/// Return value of [`DeleteStack::events`].
#[allow(clippy::module_name_repetitions)]
pub struct DeleteStackEvents<'client, 'delete>(&'delete mut DeleteStack<'client>);
impl Stream for DeleteStackEvents<'_, '_> {
type Item = StackEvent;
fn poll_next(
mut self: Pin<&mut Self>,
ctx: &mut task::Context,
) -> task::Poll<Option<Self::Item>> {
self.0.poll_next_internal(ctx)
}
}
async fn describe_stack_id(
client: &aws_sdk_cloudformation::Client,
stack_name: String,
) -> Result<Option<String>, DeleteStackError> {
let output = match client.describe_stacks().stack_name(stack_name).send().await {
Ok(output) => output,
Err(error) if is_not_exists(&error) => return Ok(None),
Err(error) => return Err(DeleteStackError::from_sdk_error(error)),
};
let stack = output
.stacks
.expect("DescribeStacksOutput without stacks")
.pop()
.expect("DescribeStacksOutput empty stacks");
if stack.stack_status == Some(aws_sdk_cloudformation::types::StackStatus::DeleteComplete) {
Ok(None)
} else {
Ok(Some(stack.stack_id.expect("Stack without stack_id")))
}
}
fn check_operation_status(stack_status: StackStatus) -> StackOperationStatus {
match stack_status {
StackStatus::DeleteInProgress => StackOperationStatus::InProgress,
StackStatus::DeleteComplete => StackOperationStatus::Complete,
StackStatus::DeleteFailed => StackOperationStatus::Failed,
_ => StackOperationStatus::Unexpected,
}
}
fn is_not_exists(error: &SdkError<DescribeStacksError>) -> bool {
error
.message()
.is_some_and(|msg| msg.contains("does not exist"))
}