Struct CreateUserPoolDomainInput 

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

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 domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

user_pool_id: Option<String>

The ID of the user pool where you want to add a domain.

managed_login_version: Option<i32>

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

Managed login requires that your user pool be configured for any feature plan other than Lite.

custom_domain_config: Option<CustomDomainConfigType>

The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead.

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 CreateUserPoolDomainInput

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

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

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

The ID of the user pool where you want to add a domain.

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

The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

Managed login requires that your user pool be configured for any feature plan other than Lite.

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

The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can omit this parameter and use a prefix domain instead.

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 CreateUserPoolDomainInput

pub fn builder() -> CreateUserPoolDomainInputBuilder

Creates a new builder-style object to manufacture CreateUserPoolDomainInput.

Trait Implementations

impl Clone for CreateUserPoolDomainInput

fn clone(&self) -> CreateUserPoolDomainInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUserPoolDomainInput

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

Formats the value using the given formatter.

impl PartialEq for CreateUserPoolDomainInput

fn eq(&self, other: &CreateUserPoolDomainInput) -> 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 CreateUserPoolDomainInput