aws_sdk_cloudformation/operation/describe_stack_instance/
_describe_stack_instance_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeStackInstanceInput {
6    /// <p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>
7    pub stack_set_name: ::std::option::Option<::std::string::String>,
8    /// <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
9    pub stack_instance_account: ::std::option::Option<::std::string::String>,
10    /// <p>The name of a Region that's associated with this stack instance.</p>
11    pub stack_instance_region: ::std::option::Option<::std::string::String>,
12    /// <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>
13    /// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
14    /// <ul>
15    /// <li>
16    /// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
17    /// <li>
18    /// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
19    /// <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>
20    /// </ul>
21    pub call_as: ::std::option::Option<crate::types::CallAs>,
22}
23impl DescribeStackInstanceInput {
24    /// <p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>
25    pub fn stack_set_name(&self) -> ::std::option::Option<&str> {
26        self.stack_set_name.as_deref()
27    }
28    /// <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
29    pub fn stack_instance_account(&self) -> ::std::option::Option<&str> {
30        self.stack_instance_account.as_deref()
31    }
32    /// <p>The name of a Region that's associated with this stack instance.</p>
33    pub fn stack_instance_region(&self) -> ::std::option::Option<&str> {
34        self.stack_instance_region.as_deref()
35    }
36    /// <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>
37    /// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
38    /// <ul>
39    /// <li>
40    /// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
41    /// <li>
42    /// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
43    /// <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>
44    /// </ul>
45    pub fn call_as(&self) -> ::std::option::Option<&crate::types::CallAs> {
46        self.call_as.as_ref()
47    }
48}
49impl DescribeStackInstanceInput {
50    /// Creates a new builder-style object to manufacture [`DescribeStackInstanceInput`](crate::operation::describe_stack_instance::DescribeStackInstanceInput).
51    pub fn builder() -> crate::operation::describe_stack_instance::builders::DescribeStackInstanceInputBuilder {
52        crate::operation::describe_stack_instance::builders::DescribeStackInstanceInputBuilder::default()
53    }
54}
55
56/// A builder for [`DescribeStackInstanceInput`](crate::operation::describe_stack_instance::DescribeStackInstanceInput).
57#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
58#[non_exhaustive]
59pub struct DescribeStackInstanceInputBuilder {
60    pub(crate) stack_set_name: ::std::option::Option<::std::string::String>,
61    pub(crate) stack_instance_account: ::std::option::Option<::std::string::String>,
62    pub(crate) stack_instance_region: ::std::option::Option<::std::string::String>,
63    pub(crate) call_as: ::std::option::Option<crate::types::CallAs>,
64}
65impl DescribeStackInstanceInputBuilder {
66    /// <p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>
67    /// This field is required.
68    pub fn stack_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
69        self.stack_set_name = ::std::option::Option::Some(input.into());
70        self
71    }
72    /// <p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>
73    pub fn set_stack_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
74        self.stack_set_name = input;
75        self
76    }
77    /// <p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>
78    pub fn get_stack_set_name(&self) -> &::std::option::Option<::std::string::String> {
79        &self.stack_set_name
80    }
81    /// <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
82    /// This field is required.
83    pub fn stack_instance_account(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
84        self.stack_instance_account = ::std::option::Option::Some(input.into());
85        self
86    }
87    /// <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
88    pub fn set_stack_instance_account(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
89        self.stack_instance_account = input;
90        self
91    }
92    /// <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
93    pub fn get_stack_instance_account(&self) -> &::std::option::Option<::std::string::String> {
94        &self.stack_instance_account
95    }
96    /// <p>The name of a Region that's associated with this stack instance.</p>
97    /// This field is required.
98    pub fn stack_instance_region(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
99        self.stack_instance_region = ::std::option::Option::Some(input.into());
100        self
101    }
102    /// <p>The name of a Region that's associated with this stack instance.</p>
103    pub fn set_stack_instance_region(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
104        self.stack_instance_region = input;
105        self
106    }
107    /// <p>The name of a Region that's associated with this stack instance.</p>
108    pub fn get_stack_instance_region(&self) -> &::std::option::Option<::std::string::String> {
109        &self.stack_instance_region
110    }
111    /// <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>
112    /// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
113    /// <ul>
114    /// <li>
115    /// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
116    /// <li>
117    /// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
118    /// <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>
119    /// </ul>
120    pub fn call_as(mut self, input: crate::types::CallAs) -> Self {
121        self.call_as = ::std::option::Option::Some(input);
122        self
123    }
124    /// <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>
125    /// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
126    /// <ul>
127    /// <li>
128    /// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
129    /// <li>
130    /// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
131    /// <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>
132    /// </ul>
133    pub fn set_call_as(mut self, input: ::std::option::Option<crate::types::CallAs>) -> Self {
134        self.call_as = input;
135        self
136    }
137    /// <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>
138    /// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
139    /// <ul>
140    /// <li>
141    /// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
142    /// <li>
143    /// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
144    /// <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>
145    /// </ul>
146    pub fn get_call_as(&self) -> &::std::option::Option<crate::types::CallAs> {
147        &self.call_as
148    }
149    /// Consumes the builder and constructs a [`DescribeStackInstanceInput`](crate::operation::describe_stack_instance::DescribeStackInstanceInput).
150    pub fn build(
151        self,
152    ) -> ::std::result::Result<crate::operation::describe_stack_instance::DescribeStackInstanceInput, ::aws_smithy_types::error::operation::BuildError>
153    {
154        ::std::result::Result::Ok(crate::operation::describe_stack_instance::DescribeStackInstanceInput {
155            stack_set_name: self.stack_set_name,
156            stack_instance_account: self.stack_instance_account,
157            stack_instance_region: self.stack_instance_region,
158            call_as: self.call_as,
159        })
160    }
161}
aws_sdk_cloudformation/operation/describe_stack_instance/_describe_stack_instance_input.rs

aws_sdk_cloudformation/operation/describe_stack_instance/
_describe_stack_instance_input.rs
