Struct aws_sdk_amplifybackend::types::CreateBackendAuthUserPoolConfig

#[non_exhaustive]
pub struct CreateBackendAuthUserPoolConfig {
    pub forgot_password: Option<CreateBackendAuthForgotPasswordConfig>,
    pub mfa: Option<CreateBackendAuthMfaConfig>,
    pub o_auth: Option<CreateBackendAuthOAuthConfig>,
    pub password_policy: Option<CreateBackendAuthPasswordPolicyConfig>,
    pub required_sign_up_attributes: Option<Vec<RequiredSignUpAttributesElement>>,
    pub sign_in_method: Option<SignInMethod>,
    pub user_pool_name: Option<String>,
    pub verification_message: Option<CreateBackendAuthVerificationMessageConfig>,
}

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

forgot_password: Option<CreateBackendAuthForgotPasswordConfig>

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

mfa: Option<CreateBackendAuthMfaConfig>

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

o_auth: Option<CreateBackendAuthOAuthConfig>

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

password_policy: Option<CreateBackendAuthPasswordPolicyConfig>

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

required_sign_up_attributes: Option<Vec<RequiredSignUpAttributesElement>>

The required attributes to sign up new users in the user pool.

sign_in_method: Option<SignInMethod>

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

user_pool_name: Option<String>

The Amazon Cognito user pool name.

verification_message: Option<CreateBackendAuthVerificationMessageConfig>

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

Implementations

impl CreateBackendAuthUserPoolConfig

pub fn forgot_password(&self) -> Option<&CreateBackendAuthForgotPasswordConfig>

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

pub fn mfa(&self) -> Option<&CreateBackendAuthMfaConfig>

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

pub fn o_auth(&self) -> Option<&CreateBackendAuthOAuthConfig>

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

pub fn password_policy(&self) -> Option<&CreateBackendAuthPasswordPolicyConfig>

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

pub fn required_sign_up_attributes(&self) -> &[RequiredSignUpAttributesElement]

The required attributes to sign up new users in the user pool.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .required_sign_up_attributes.is_none().

pub fn sign_in_method(&self) -> Option<&SignInMethod>

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

pub fn user_pool_name(&self) -> Option<&str>

The Amazon Cognito user pool name.

pub fn verification_message( &self ) -> Option<&CreateBackendAuthVerificationMessageConfig>

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

impl CreateBackendAuthUserPoolConfig

pub fn builder() -> CreateBackendAuthUserPoolConfigBuilder

Creates a new builder-style object to manufacture CreateBackendAuthUserPoolConfig.

Trait Implementations

impl Clone for CreateBackendAuthUserPoolConfig

fn clone(&self) -> CreateBackendAuthUserPoolConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateBackendAuthUserPoolConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateBackendAuthUserPoolConfig

fn eq(&self, other: &CreateBackendAuthUserPoolConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateBackendAuthUserPoolConfig