aws_sdk_cloudformation/client/
describe_stack_instance.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 [`DescribeStackInstance`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`stack_set_name(impl Into<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::stack_set_name) / [`set_stack_set_name(Option<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::set_stack_set_name):<br>required: **true**<br><p>The name or the unique stack ID of the StackSet that you want to get stack instance information for.</p><br>
7    ///   - [`stack_instance_account(impl Into<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::stack_instance_account) / [`set_stack_instance_account(Option<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::set_stack_instance_account):<br>required: **true**<br><p>The ID of an Amazon Web Services account that's associated with this stack instance.</p><br>
8    ///   - [`stack_instance_region(impl Into<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::stack_instance_region) / [`set_stack_instance_region(Option<String>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::set_stack_instance_region):<br>required: **true**<br><p>The name of a Region that's associated with this stack instance.</p><br>
9    ///   - [`call_as(CallAs)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::call_as) / [`set_call_as(Option<CallAs>)`](crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::set_call_as):<br>required: **false**<br><p>\[Service-managed permissions\] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul>  <li>   <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>  <li>   <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>   <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li> </ul><br>
10    /// - On success, responds with [`DescribeStackInstanceOutput`](crate::operation::describe_stack_instance::DescribeStackInstanceOutput) with field(s):
11    ///   - [`stack_instance(Option<StackInstance>)`](crate::operation::describe_stack_instance::DescribeStackInstanceOutput::stack_instance): <p>The stack instance that matches the specified request parameters.</p>
12    /// - On failure, responds with [`SdkError<DescribeStackInstanceError>`](crate::operation::describe_stack_instance::DescribeStackInstanceError)
13    pub fn describe_stack_instance(&self) -> crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder {
14        crate::operation::describe_stack_instance::builders::DescribeStackInstanceFluentBuilder::new(self.handle.clone())
15    }
16}