aws_sdk_cloudformation/client/describe_stack_resources.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 [`DescribeStackResources`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`stack_name(impl Into<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::set_stack_name):<br>required: **false**<br><p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p> <ul> <li> <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li> <li> <p>Deleted stacks: You must specify the unique stack ID.</p></li> </ul> <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p><br>
7 /// - [`logical_resource_id(impl Into<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::logical_resource_id) / [`set_logical_resource_id(Option<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::set_logical_resource_id):<br>required: **false**<br><p>The logical name of the resource as specified in the template.</p><br>
8 /// - [`physical_resource_id(impl Into<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::physical_resource_id) / [`set_physical_resource_id(Option<String>)`](crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::set_physical_resource_id):<br>required: **false**<br><p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p> <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p> <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p><br>
9 /// - On success, responds with [`DescribeStackResourcesOutput`](crate::operation::describe_stack_resources::DescribeStackResourcesOutput) with field(s):
10 /// - [`stack_resources(Option<Vec::<StackResource>>)`](crate::operation::describe_stack_resources::DescribeStackResourcesOutput::stack_resources): <p>A list of <code>StackResource</code> structures.</p>
11 /// - On failure, responds with [`SdkError<DescribeStackResourcesError>`](crate::operation::describe_stack_resources::DescribeStackResourcesError)
12 pub fn describe_stack_resources(&self) -> crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder {
13 crate::operation::describe_stack_resources::builders::DescribeStackResourcesFluentBuilder::new(self.handle.clone())
14 }
15}