#[non_exhaustive]pub struct DeleteStackInput {
pub stack_name: Option<String>,
pub retain_resources: Option<Vec<String>>,
pub role_arn: Option<String>,
pub client_request_token: Option<String>,
}
Expand description
The input for DeleteStack
action.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stack_name: Option<String>
The name or the unique stack ID that's associated with the stack.
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, CloudFormation deletes the stack but doesn't delete the retained resources.
Retaining resources is useful when you can't 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 Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
client_request_token: Option<String>
A unique identifier for this DeleteStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack
requests to ensure that CloudFormation successfully received them.
All events initiated 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
.
Implementations§
source§impl DeleteStackInput
impl DeleteStackInput
sourcepub fn stack_name(&self) -> Option<&str>
pub fn stack_name(&self) -> Option<&str>
The name or the unique stack ID that's associated with the stack.
sourcepub fn retain_resources(&self) -> &[String]
pub fn retain_resources(&self) -> &[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, CloudFormation deletes the stack but doesn't delete the retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete 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 .retain_resources.is_none()
.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that's generated from your user credentials.
sourcepub fn client_request_token(&self) -> Option<&str>
pub fn client_request_token(&self) -> Option<&str>
A unique identifier for this DeleteStack
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack
requests to ensure that CloudFormation successfully received them.
All events initiated 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
.
source§impl DeleteStackInput
impl DeleteStackInput
sourcepub fn builder() -> DeleteStackInputBuilder
pub fn builder() -> DeleteStackInputBuilder
Creates a new builder-style object to manufacture DeleteStackInput
.
Trait Implementations§
source§impl Clone for DeleteStackInput
impl Clone for DeleteStackInput
source§fn clone(&self) -> DeleteStackInput
fn clone(&self) -> DeleteStackInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DeleteStackInput
impl Debug for DeleteStackInput
source§impl PartialEq for DeleteStackInput
impl PartialEq for DeleteStackInput
source§fn eq(&self, other: &DeleteStackInput) -> bool
fn eq(&self, other: &DeleteStackInput) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for DeleteStackInput
Auto Trait Implementations§
impl Freeze for DeleteStackInput
impl RefUnwindSafe for DeleteStackInput
impl Send for DeleteStackInput
impl Sync for DeleteStackInput
impl Unpin for DeleteStackInput
impl UnwindSafe for DeleteStackInput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more