Struct DomainDescriptionType 

#[non_exhaustive]
pub struct DomainDescriptionType {
    pub user_pool_id: Option<String>,
    pub aws_account_id: Option<String>,
    pub domain: Option<String>,
    pub s3_bucket: Option<String>,
    pub cloud_front_distribution: Option<String>,
    pub version: Option<String>,
    pub status: Option<DomainStatusType>,
    pub custom_domain_config: Option<CustomDomainConfigType>,
    pub managed_login_version: Option<i32>,
}

A container for information about the user pool domain associated with the hosted UI and OAuth endpoints.

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.

user_pool_id: Option<String>

The ID of the user pool that the domain is attached to.

aws_account_id: Option<String>

The Amazon Web Services account that you created the user pool in.

domain: Option<String>

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

s3_bucket: Option<String>

The Amazon S3 bucket where the static files for this domain are stored.

cloud_front_distribution: Option<String>

The Amazon CloudFront endpoint that hosts your custom domain.

version: Option<String>

The app version.

status: Option<DomainStatusType>

The domain status.

custom_domain_config: Option<CustomDomainConfigType>

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

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) branding and a version of 2 indicates managed login branding.

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

Implementations

impl DomainDescriptionType

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

The ID of the user pool that the domain is attached to.

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

The Amazon Web Services account that you created the user pool in.

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 Amazon Cognito prefix domains, this is the prefix alone, such as auth.

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

The Amazon S3 bucket where the static files for this domain are stored.

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

The Amazon CloudFront endpoint that hosts your custom domain.

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

The app version.

pub fn status(&self) -> Option<&DomainStatusType>

The domain status.

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

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

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) branding and a version of 2 indicates managed login branding.

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

impl DomainDescriptionType

pub fn builder() -> DomainDescriptionTypeBuilder

Creates a new builder-style object to manufacture DomainDescriptionType.

Trait Implementations

impl Clone for DomainDescriptionType

fn clone(&self) -> DomainDescriptionType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DomainDescriptionType

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

Formats the value using the given formatter.

impl PartialEq for DomainDescriptionType

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