1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_user_pool::_update_user_pool_output::UpdateUserPoolOutputBuilder;
pub use crate::operation::update_user_pool::_update_user_pool_input::UpdateUserPoolInputBuilder;
impl UpdateUserPoolInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::update_user_pool::UpdateUserPoolOutput,
::aws_smithy_http::result::SdkError<
crate::operation::update_user_pool::UpdateUserPoolError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.update_user_pool();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `UpdateUserPool`.
///
/// <p>Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>. If you don't provide a value for an attribute, it will be set to the default value. </p> <note>
/// <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p>
/// <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-sms-userpool-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct UpdateUserPoolFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_user_pool::builders::UpdateUserPoolInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl UpdateUserPoolFluentBuilder {
/// Creates a new `UpdateUserPool`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the UpdateUserPool as a reference.
pub fn as_input(&self) -> &crate::operation::update_user_pool::builders::UpdateUserPoolInputBuilder {
&self.inner
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::update_user_pool::UpdateUserPoolOutput,
::aws_smithy_http::result::SdkError<
crate::operation::update_user_pool::UpdateUserPoolError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self.inner.build().map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::update_user_pool::UpdateUserPool::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::update_user_pool::UpdateUserPool::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being
/// sent.
// TODO(enableNewSmithyRuntimeCleanup): Remove `async` and `Result` once we switch to orchestrator
pub async fn customize(
self,
) -> ::std::result::Result<
crate::client::customize::orchestrator::CustomizableOperation<
crate::operation::update_user_pool::UpdateUserPoolOutput,
crate::operation::update_user_pool::UpdateUserPoolError,
>,
::aws_smithy_http::result::SdkError<crate::operation::update_user_pool::UpdateUserPoolError>,
> {
::std::result::Result::Ok(crate::client::customize::orchestrator::CustomizableOperation {
customizable_send: ::std::boxed::Box::new(move |config_override| {
::std::boxed::Box::pin(async { self.config_override(config_override).send().await })
}),
config_override: None,
interceptors: vec![],
runtime_plugins: vec![],
})
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The user pool ID for the user pool you want to update.</p>
pub fn user_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.user_pool_id(input.into());
self
}
/// <p>The user pool ID for the user pool you want to update.</p>
pub fn set_user_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_user_pool_id(input);
self
}
/// <p>The user pool ID for the user pool you want to update.</p>
pub fn get_user_pool_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_user_pool_id()
}
/// <p>A container with the policies you want to update in a user pool.</p>
pub fn policies(mut self, input: crate::types::UserPoolPolicyType) -> Self {
self.inner = self.inner.policies(input);
self
}
/// <p>A container with the policies you want to update in a user pool.</p>
pub fn set_policies(mut self, input: ::std::option::Option<crate::types::UserPoolPolicyType>) -> Self {
self.inner = self.inner.set_policies(input);
self
}
/// <p>A container with the policies you want to update in a user pool.</p>
pub fn get_policies(&self) -> &::std::option::Option<crate::types::UserPoolPolicyType> {
self.inner.get_policies()
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn deletion_protection(mut self, input: crate::types::DeletionProtectionType) -> Self {
self.inner = self.inner.deletion_protection(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn set_deletion_protection(mut self, input: ::std::option::Option<crate::types::DeletionProtectionType>) -> Self {
self.inner = self.inner.set_deletion_protection(input);
self
}
/// <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p>
/// <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>
pub fn get_deletion_protection(&self) -> &::std::option::Option<crate::types::DeletionProtectionType> {
self.inner.get_deletion_protection()
}
/// <p>The Lambda configuration information from the request to update the user pool.</p>
pub fn lambda_config(mut self, input: crate::types::LambdaConfigType) -> Self {
self.inner = self.inner.lambda_config(input);
self
}
/// <p>The Lambda configuration information from the request to update the user pool.</p>
pub fn set_lambda_config(mut self, input: ::std::option::Option<crate::types::LambdaConfigType>) -> Self {
self.inner = self.inner.set_lambda_config(input);
self
}
/// <p>The Lambda configuration information from the request to update the user pool.</p>
pub fn get_lambda_config(&self) -> &::std::option::Option<crate::types::LambdaConfigType> {
self.inner.get_lambda_config()
}
/// Appends an item to `AutoVerifiedAttributes`.
///
/// To override the contents of this collection use [`set_auto_verified_attributes`](Self::set_auto_verified_attributes).
///
/// <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
pub fn auto_verified_attributes(mut self, input: crate::types::VerifiedAttributeType) -> Self {
self.inner = self.inner.auto_verified_attributes(input);
self
}
/// <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
pub fn set_auto_verified_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::VerifiedAttributeType>>) -> Self {
self.inner = self.inner.set_auto_verified_attributes(input);
self
}
/// <p>The attributes that are automatically verified when Amazon Cognito requests to update user pools.</p>
pub fn get_auto_verified_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::VerifiedAttributeType>> {
self.inner.get_auto_verified_attributes()
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn sms_verification_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.sms_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_sms_verification_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_sms_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn get_sms_verification_message(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_sms_verification_message()
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.email_verification_message(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_email_verification_message(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn get_email_verification_message(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_email_verification_message()
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn email_verification_subject(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.email_verification_subject(input.into());
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn set_email_verification_subject(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_email_verification_subject(input);
self
}
/// <p>This parameter is no longer used. See <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html">VerificationMessageTemplateType</a>.</p>
pub fn get_email_verification_subject(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_email_verification_subject()
}
/// <p>The template for verification messages.</p>
pub fn verification_message_template(mut self, input: crate::types::VerificationMessageTemplateType) -> Self {
self.inner = self.inner.verification_message_template(input);
self
}
/// <p>The template for verification messages.</p>
pub fn set_verification_message_template(mut self, input: ::std::option::Option<crate::types::VerificationMessageTemplateType>) -> Self {
self.inner = self.inner.set_verification_message_template(input);
self
}
/// <p>The template for verification messages.</p>
pub fn get_verification_message_template(&self) -> &::std::option::Option<crate::types::VerificationMessageTemplateType> {
self.inner.get_verification_message_template()
}
/// <p>The contents of the SMS authentication message.</p>
pub fn sms_authentication_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.sms_authentication_message(input.into());
self
}
/// <p>The contents of the SMS authentication message.</p>
pub fn set_sms_authentication_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_sms_authentication_message(input);
self
}
/// <p>The contents of the SMS authentication message.</p>
pub fn get_sms_authentication_message(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_sms_authentication_message()
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn user_attribute_update_settings(mut self, input: crate::types::UserAttributeUpdateSettingsType) -> Self {
self.inner = self.inner.user_attribute_update_settings(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn set_user_attribute_update_settings(mut self, input: ::std::option::Option<crate::types::UserAttributeUpdateSettingsType>) -> Self {
self.inner = self.inner.set_user_attribute_update_settings(input);
self
}
/// <p>The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates"> Verifying updates to email addresses and phone numbers</a>.</p>
pub fn get_user_attribute_update_settings(&self) -> &::std::option::Option<crate::types::UserAttributeUpdateSettingsType> {
self.inner.get_user_attribute_update_settings()
}
/// <p>Possible values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li>
/// <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li>
/// <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li>
/// </ul>
pub fn mfa_configuration(mut self, input: crate::types::UserPoolMfaType) -> Self {
self.inner = self.inner.mfa_configuration(input);
self
}
/// <p>Possible values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li>
/// <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li>
/// <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li>
/// </ul>
pub fn set_mfa_configuration(mut self, input: ::std::option::Option<crate::types::UserPoolMfaType>) -> Self {
self.inner = self.inner.set_mfa_configuration(input);
self
}
/// <p>Possible values include:</p>
/// <ul>
/// <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li>
/// <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing user pools. </p> </li>
/// <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li>
/// </ul>
pub fn get_mfa_configuration(&self) -> &::std::option::Option<crate::types::UserPoolMfaType> {
self.inner.get_mfa_configuration()
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn device_configuration(mut self, input: crate::types::DeviceConfigurationType) -> Self {
self.inner = self.inner.device_configuration(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn set_device_configuration(mut self, input: ::std::option::Option<crate::types::DeviceConfigurationType>) -> Self {
self.inner = self.inner.set_device_configuration(input);
self
}
/// <p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note>
/// <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p>
/// </note>
pub fn get_device_configuration(&self) -> &::std::option::Option<crate::types::DeviceConfigurationType> {
self.inner.get_device_configuration()
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
pub fn email_configuration(mut self, input: crate::types::EmailConfigurationType) -> Self {
self.inner = self.inner.email_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
pub fn set_email_configuration(mut self, input: ::std::option::Option<crate::types::EmailConfigurationType>) -> Self {
self.inner = self.inner.set_email_configuration(input);
self
}
/// <p>The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.</p>
pub fn get_email_configuration(&self) -> &::std::option::Option<crate::types::EmailConfigurationType> {
self.inner.get_email_configuration()
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn sms_configuration(mut self, input: crate::types::SmsConfigurationType) -> Self {
self.inner = self.inner.sms_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn set_sms_configuration(mut self, input: ::std::option::Option<crate::types::SmsConfigurationType>) -> Self {
self.inner = self.inner.set_sms_configuration(input);
self
}
/// <p>The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
pub fn get_sms_configuration(&self) -> &::std::option::Option<crate::types::SmsConfigurationType> {
self.inner.get_sms_configuration()
}
/// Adds a key-value pair to `UserPoolTags`.
///
/// To override the contents of this collection use [`set_user_pool_tags`](Self::set_user_pool_tags).
///
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn user_pool_tags(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.user_pool_tags(k.into(), v.into());
self
}
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn set_user_pool_tags(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.inner = self.inner.set_user_pool_tags(input);
self
}
/// <p>The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.</p>
pub fn get_user_pool_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.inner.get_user_pool_tags()
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn admin_create_user_config(mut self, input: crate::types::AdminCreateUserConfigType) -> Self {
self.inner = self.inner.admin_create_user_config(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn set_admin_create_user_config(mut self, input: ::std::option::Option<crate::types::AdminCreateUserConfigType>) -> Self {
self.inner = self.inner.set_admin_create_user_config(input);
self
}
/// <p>The configuration for <code>AdminCreateUser</code> requests.</p>
pub fn get_admin_create_user_config(&self) -> &::std::option::Option<crate::types::AdminCreateUserConfigType> {
self.inner.get_admin_create_user_config()
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn user_pool_add_ons(mut self, input: crate::types::UserPoolAddOnsType) -> Self {
self.inner = self.inner.user_pool_add_ons(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn set_user_pool_add_ons(mut self, input: ::std::option::Option<crate::types::UserPoolAddOnsType>) -> Self {
self.inner = self.inner.set_user_pool_add_ons(input);
self
}
/// <p>Enables advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value "AUDIT".</p>
pub fn get_user_pool_add_ons(&self) -> &::std::option::Option<crate::types::UserPoolAddOnsType> {
self.inner.get_user_pool_add_ons()
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn account_recovery_setting(mut self, input: crate::types::AccountRecoverySettingType) -> Self {
self.inner = self.inner.account_recovery_setting(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn set_account_recovery_setting(mut self, input: ::std::option::Option<crate::types::AccountRecoverySettingType>) -> Self {
self.inner = self.inner.set_account_recovery_setting(input);
self
}
/// <p>The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.</p>
pub fn get_account_recovery_setting(&self) -> &::std::option::Option<crate::types::AccountRecoverySettingType> {
self.inner.get_account_recovery_setting()
}
}