Struct CreateUserPoolDomainInputBuilder 

#[non_exhaustive]
pub struct CreateUserPoolDomainInputBuilder { /* private fields */ }

A builder for CreateUserPoolDomainInput.

Implementations

impl CreateUserPoolDomainInputBuilder

pub fn domain(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_domain(self, input: Option<String>) -> Self

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 get_domain(&self) -> &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.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

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

pub fn get_user_pool_id(&self) -> &Option<String>

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

pub fn managed_login_version(self, input: i32) -> Self

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 set_managed_login_version(self, input: Option<i32>) -> Self

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 get_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, input: CustomDomainConfigType) -> Self

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.

pub fn set_custom_domain_config( self, input: Option<CustomDomainConfigType>, ) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<CreateUserPoolDomainInput, BuildError>

Consumes the builder and constructs a CreateUserPoolDomainInput.

impl CreateUserPoolDomainInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<CreateUserPoolDomainOutput, SdkError<CreateUserPoolDomainError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateUserPoolDomainInputBuilder

fn clone(&self) -> CreateUserPoolDomainInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUserPoolDomainInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateUserPoolDomainInputBuilder

fn default() -> CreateUserPoolDomainInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateUserPoolDomainInputBuilder

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