Struct aws_sdk_cloudformation::client::fluent_builders::DescribeStackResources

pub struct DescribeStackResources<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

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

impl<C, M, R> DescribeStackResources<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeStackResourcesOutput, SdkError<DescribeStackResourcesError>> where
    R::Policy: SmithyRetryPolicy<DescribeStackResourcesInputOperationOutputAlias, DescribeStackResourcesOutput, DescribeStackResourcesError, DescribeStackResourcesInputOperationRetryAlias>, 

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.

pub fn stack_name(self, inp: impl Into<String>) -> Self

The name or the unique stack ID that is associated with the stack, which are not 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 do not specify StackName, you must specify PhysicalResourceId.

pub fn set_stack_name(self, input: Option<String>) -> Self

The name or the unique stack ID that is associated with the stack, which are not 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 do not specify StackName, you must specify PhysicalResourceId.

pub fn logical_resource_id(self, inp: impl Into<String>) -> Self

The logical name of the resource as specified in the template.

Default: There is no default value.

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.

pub fn physical_resource_id(self, inp: 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 do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

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 do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeStackResources<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.