Skip to main content

aws_sdk_ssoadmin/client/
update_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 [`UpdateInstance`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::set_name):<br>required: **false**<br><p>Updates the instance name.</p><br>
7    ///   - [`instance_arn(impl Into<String>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::instance_arn) / [`set_instance_arn(Option<String>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::set_instance_arn):<br>required: **true**<br><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><br>
8    ///   - [`encryption_configuration(EncryptionConfiguration)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::encryption_configuration) / [`set_encryption_configuration(Option<EncryptionConfiguration>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::set_encryption_configuration):<br>required: **false**<br><p>Specifies the encryption configuration for your IAM Identity Center instance. You can use this to configure customer managed KMS keys or Amazon Web Services owned KMS keys for encrypting your instance data.</p><br>
9    ///   - [`permission_sets_enabled(bool)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::permission_sets_enabled) / [`set_permission_sets_enabled(Option<bool>)`](crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::set_permission_sets_enabled):<br>required: **false**<br><p>Enables permission sets for this Identity Center instance. The only accepted value is <code>true </code>. After permission sets are enabled, they cannot be disabled.</p><note>  <p>You can't set <code>EncryptionConfiguration</code> and <code>PermissionSetsEnabled</code> in the same request. To configure both, make two separate <code>UpdateInstance</code> calls. These calls can be made in parallel.</p> </note><br>
10    /// - On success, responds with [`UpdateInstanceOutput`](crate::operation::update_instance::UpdateInstanceOutput)
11    /// - On failure, responds with [`SdkError<UpdateInstanceError>`](crate::operation::update_instance::UpdateInstanceError)
12    pub fn update_instance(&self) -> crate::operation::update_instance::builders::UpdateInstanceFluentBuilder {
13        crate::operation::update_instance::builders::UpdateInstanceFluentBuilder::new(self.handle.clone())
14    }
15}