Struct UpdateUserPoolDomainInput 

#[non_exhaustive]
pub struct UpdateUserPoolDomainInput {
    pub domain: Option<String>,
    pub user_pool_id: Option<String>,
    pub managed_login_version: Option<i32>,
    pub custom_domain_config: Option<CustomDomainConfigType>,
}

The UpdateUserPoolDomain request input.

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.

domain: Option<String>

The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com. For prefix domains, this is the prefix alone, such as myprefix.

user_pool_id: Option<String>

The ID of the user pool that is associated with the domain you're updating.

managed_login_version: Option<i32>

A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding editor. For more information, see Managed login.

custom_domain_config: Option<CustomDomainConfigType>

The configuration for a custom domain that hosts managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

Implementations

impl UpdateUserPoolDomainInput

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

The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com. For prefix domains, this is the prefix alone, such as myprefix.

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

The ID of the user pool that is associated with the domain you're updating.

pub fn managed_login_version(&self) -> Option<i32>

A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding editor. For more information, see Managed login.

pub fn custom_domain_config(&self) -> Option<&CustomDomainConfigType>

The configuration for a custom domain that hosts managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1.

When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain.

impl UpdateUserPoolDomainInput

pub fn builder() -> UpdateUserPoolDomainInputBuilder

Creates a new builder-style object to manufacture UpdateUserPoolDomainInput.

Trait Implementations

impl Clone for UpdateUserPoolDomainInput

fn clone(&self) -> UpdateUserPoolDomainInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserPoolDomainInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateUserPoolDomainInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UpdateUserPoolDomainInput