aws_sdk_ssoadmin/operation/describe_instance/_describe_instance_output.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 DescribeInstanceOutput {
6 /// <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
7 pub instance_arn: ::std::option::Option<::std::string::String>,
8 /// <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
9 pub identity_store_id: ::std::option::Option<::std::string::String>,
10 /// <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
11 pub owner_account_id: ::std::option::Option<::std::string::String>,
12 /// <p>Specifies the instance name.</p>
13 pub name: ::std::option::Option<::std::string::String>,
14 /// <p>The date the instance was created.</p>
15 pub created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
16 /// <p>The status of the instance.</p>
17 pub status: ::std::option::Option<crate::types::InstanceStatus>,
18 /// <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
19 pub status_reason: ::std::option::Option<::std::string::String>,
20 /// <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
21 pub encryption_configuration_details: ::std::option::Option<crate::types::EncryptionConfigurationDetails>,
22 _request_id: Option<String>,
23}
24impl DescribeInstanceOutput {
25 /// <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
26 pub fn instance_arn(&self) -> ::std::option::Option<&str> {
27 self.instance_arn.as_deref()
28 }
29 /// <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
30 pub fn identity_store_id(&self) -> ::std::option::Option<&str> {
31 self.identity_store_id.as_deref()
32 }
33 /// <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
34 pub fn owner_account_id(&self) -> ::std::option::Option<&str> {
35 self.owner_account_id.as_deref()
36 }
37 /// <p>Specifies the instance name.</p>
38 pub fn name(&self) -> ::std::option::Option<&str> {
39 self.name.as_deref()
40 }
41 /// <p>The date the instance was created.</p>
42 pub fn created_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
43 self.created_date.as_ref()
44 }
45 /// <p>The status of the instance.</p>
46 pub fn status(&self) -> ::std::option::Option<&crate::types::InstanceStatus> {
47 self.status.as_ref()
48 }
49 /// <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
50 pub fn status_reason(&self) -> ::std::option::Option<&str> {
51 self.status_reason.as_deref()
52 }
53 /// <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
54 pub fn encryption_configuration_details(&self) -> ::std::option::Option<&crate::types::EncryptionConfigurationDetails> {
55 self.encryption_configuration_details.as_ref()
56 }
57}
58impl ::aws_types::request_id::RequestId for DescribeInstanceOutput {
59 fn request_id(&self) -> Option<&str> {
60 self._request_id.as_deref()
61 }
62}
63impl DescribeInstanceOutput {
64 /// Creates a new builder-style object to manufacture [`DescribeInstanceOutput`](crate::operation::describe_instance::DescribeInstanceOutput).
65 pub fn builder() -> crate::operation::describe_instance::builders::DescribeInstanceOutputBuilder {
66 crate::operation::describe_instance::builders::DescribeInstanceOutputBuilder::default()
67 }
68}
69
70/// A builder for [`DescribeInstanceOutput`](crate::operation::describe_instance::DescribeInstanceOutput).
71#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
72#[non_exhaustive]
73pub struct DescribeInstanceOutputBuilder {
74 pub(crate) instance_arn: ::std::option::Option<::std::string::String>,
75 pub(crate) identity_store_id: ::std::option::Option<::std::string::String>,
76 pub(crate) owner_account_id: ::std::option::Option<::std::string::String>,
77 pub(crate) name: ::std::option::Option<::std::string::String>,
78 pub(crate) created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
79 pub(crate) status: ::std::option::Option<crate::types::InstanceStatus>,
80 pub(crate) status_reason: ::std::option::Option<::std::string::String>,
81 pub(crate) encryption_configuration_details: ::std::option::Option<crate::types::EncryptionConfigurationDetails>,
82 _request_id: Option<String>,
83}
84impl DescribeInstanceOutputBuilder {
85 /// <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
86 pub fn instance_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
87 self.instance_arn = ::std::option::Option::Some(input.into());
88 self
89 }
90 /// <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
91 pub fn set_instance_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
92 self.instance_arn = input;
93 self
94 }
95 /// <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
96 pub fn get_instance_arn(&self) -> &::std::option::Option<::std::string::String> {
97 &self.instance_arn
98 }
99 /// <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
100 pub fn identity_store_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
101 self.identity_store_id = ::std::option::Option::Some(input.into());
102 self
103 }
104 /// <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
105 pub fn set_identity_store_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
106 self.identity_store_id = input;
107 self
108 }
109 /// <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
110 pub fn get_identity_store_id(&self) -> &::std::option::Option<::std::string::String> {
111 &self.identity_store_id
112 }
113 /// <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
114 pub fn owner_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115 self.owner_account_id = ::std::option::Option::Some(input.into());
116 self
117 }
118 /// <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
119 pub fn set_owner_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120 self.owner_account_id = input;
121 self
122 }
123 /// <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
124 pub fn get_owner_account_id(&self) -> &::std::option::Option<::std::string::String> {
125 &self.owner_account_id
126 }
127 /// <p>Specifies the instance name.</p>
128 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129 self.name = ::std::option::Option::Some(input.into());
130 self
131 }
132 /// <p>Specifies the instance name.</p>
133 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134 self.name = input;
135 self
136 }
137 /// <p>Specifies the instance name.</p>
138 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
139 &self.name
140 }
141 /// <p>The date the instance was created.</p>
142 pub fn created_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
143 self.created_date = ::std::option::Option::Some(input);
144 self
145 }
146 /// <p>The date the instance was created.</p>
147 pub fn set_created_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
148 self.created_date = input;
149 self
150 }
151 /// <p>The date the instance was created.</p>
152 pub fn get_created_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
153 &self.created_date
154 }
155 /// <p>The status of the instance.</p>
156 pub fn status(mut self, input: crate::types::InstanceStatus) -> Self {
157 self.status = ::std::option::Option::Some(input);
158 self
159 }
160 /// <p>The status of the instance.</p>
161 pub fn set_status(mut self, input: ::std::option::Option<crate::types::InstanceStatus>) -> Self {
162 self.status = input;
163 self
164 }
165 /// <p>The status of the instance.</p>
166 pub fn get_status(&self) -> &::std::option::Option<crate::types::InstanceStatus> {
167 &self.status
168 }
169 /// <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
170 pub fn status_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
171 self.status_reason = ::std::option::Option::Some(input.into());
172 self
173 }
174 /// <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
175 pub fn set_status_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
176 self.status_reason = input;
177 self
178 }
179 /// <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
180 pub fn get_status_reason(&self) -> &::std::option::Option<::std::string::String> {
181 &self.status_reason
182 }
183 /// <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
184 pub fn encryption_configuration_details(mut self, input: crate::types::EncryptionConfigurationDetails) -> Self {
185 self.encryption_configuration_details = ::std::option::Option::Some(input);
186 self
187 }
188 /// <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
189 pub fn set_encryption_configuration_details(mut self, input: ::std::option::Option<crate::types::EncryptionConfigurationDetails>) -> Self {
190 self.encryption_configuration_details = input;
191 self
192 }
193 /// <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
194 pub fn get_encryption_configuration_details(&self) -> &::std::option::Option<crate::types::EncryptionConfigurationDetails> {
195 &self.encryption_configuration_details
196 }
197 pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
198 self._request_id = Some(request_id.into());
199 self
200 }
201
202 pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
203 self._request_id = request_id;
204 self
205 }
206 /// Consumes the builder and constructs a [`DescribeInstanceOutput`](crate::operation::describe_instance::DescribeInstanceOutput).
207 pub fn build(self) -> crate::operation::describe_instance::DescribeInstanceOutput {
208 crate::operation::describe_instance::DescribeInstanceOutput {
209 instance_arn: self.instance_arn,
210 identity_store_id: self.identity_store_id,
211 owner_account_id: self.owner_account_id,
212 name: self.name,
213 created_date: self.created_date,
214 status: self.status,
215 status_reason: self.status_reason,
216 encryption_configuration_details: self.encryption_configuration_details,
217 _request_id: self._request_id,
218 }
219 }
220}