Struct aws_sdk_cognitoidentityprovider::operation::create_user_pool_domain::builders::CreateUserPoolDomainFluentBuilder

pub struct CreateUserPoolDomainFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateUserPoolDomain.

Creates a new domain for a user pool.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl CreateUserPoolDomainFluentBuilder

pub fn as_input(&self) -> &CreateUserPoolDomainInputBuilder

Access the CreateUserPoolDomain as a reference.

pub async fn send( self ) -> Result<CreateUserPoolDomainOutput, SdkError<CreateUserPoolDomainError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateUserPoolDomainOutput, CreateUserPoolDomainError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

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

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

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

The user pool ID.

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

The user pool ID.

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

The user pool ID.

pub fn custom_domain_config(self, input: CustomDomainConfigType) -> Self

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

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

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

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

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

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

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

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

Trait Implementations

impl Clone for CreateUserPoolDomainFluentBuilder

fn clone(&self) -> CreateUserPoolDomainFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateUserPoolDomainFluentBuilder

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

Formats the value using the given formatter.