Class: Aws::CognitoIdentityProvider::Types::CreateUserPoolDomainRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_domain_config ⇒ Types::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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html

Returns:



3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3435

class CreateUserPoolDomainRequest < Struct.new(
  :domain,
  :user_pool_id,
  :custom_domain_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ 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`.

Returns:

  • (String) 


3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3435

class CreateUserPoolDomainRequest < Struct.new(
  :domain,
  :user_pool_id,
  :custom_domain_config)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) 


3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 3435

class CreateUserPoolDomainRequest < Struct.new(
  :domain,
  :user_pool_id,
  :custom_domain_config)
  SENSITIVE = []
  include Aws::Structure
end