pub struct DescribeStackResources { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeStackResources
.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName
is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId
is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources
instead.
For deleted stacks, DescribeStackResources
returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not both. In addition, you can specify LogicalResourceId
to filter the returned result. For more information about resources, the LogicalResourceId
and PhysicalResourceId
, go to the CloudFormation User Guide.
A ValidationError
is returned if you specify both StackName
and PhysicalResourceId
in the same request.
Implementations
sourceimpl DescribeStackResources
impl DescribeStackResources
sourcepub async fn send(
self
) -> Result<DescribeStackResourcesOutput, SdkError<DescribeStackResourcesError>>
pub async fn send(
self
) -> Result<DescribeStackResourcesOutput, SdkError<DescribeStackResourcesError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn stack_name(self, input: impl Into<String>) -> Self
pub fn stack_name(self, input: impl Into<String>) -> Self
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
-
Running stacks: You can specify either the stack's name or its unique stack ID.
-
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
Required: Conditional. If you don't specify StackName
, you must specify PhysicalResourceId
.
sourcepub fn set_stack_name(self, input: Option<String>) -> Self
pub fn set_stack_name(self, input: Option<String>) -> Self
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
-
Running stacks: You can specify either the stack's name or its unique stack ID.
-
Deleted stacks: You must specify the unique stack ID.
Default: There is no default value.
Required: Conditional. If you don't specify StackName
, you must specify PhysicalResourceId
.
sourcepub fn logical_resource_id(self, input: impl Into<String>) -> Self
pub fn logical_resource_id(self, input: impl Into<String>) -> Self
The logical name of the resource as specified in the template.
Default: There is no default value.
sourcepub fn set_logical_resource_id(self, input: Option<String>) -> Self
pub fn set_logical_resource_id(self, input: Option<String>) -> Self
The logical name of the resource as specified in the template.
Default: There is no default value.
sourcepub fn physical_resource_id(self, input: impl Into<String>) -> Self
pub fn physical_resource_id(self, input: impl Into<String>) -> Self
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
corresponds to the InstanceId
. You can pass the EC2 InstanceId
to DescribeStackResources
to find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId
, you must specify StackName
.
Default: There is no default value.
sourcepub fn set_physical_resource_id(self, input: Option<String>) -> Self
pub fn set_physical_resource_id(self, input: Option<String>) -> Self
The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
corresponds to the InstanceId
. You can pass the EC2 InstanceId
to DescribeStackResources
to find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId
, you must specify StackName
.
Default: There is no default value.
Trait Implementations
sourceimpl Clone for DescribeStackResources
impl Clone for DescribeStackResources
sourcefn clone(&self) -> DescribeStackResources
fn clone(&self) -> DescribeStackResources
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DescribeStackResources
impl Send for DescribeStackResources
impl Sync for DescribeStackResources
impl Unpin for DescribeStackResources
impl !UnwindSafe for DescribeStackResources
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more