You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateUserPoolDomainRequest data as a hash:

{
  domain: "DomainType", # required
  user_pool_id: "UserPoolIdType", # required
  custom_domain_config: {
    certificate_arn: "ArnType", # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#custom_domain_configTypes::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.



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

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

#domainString

The domain string.

Returns:

  • (String)


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

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

#user_pool_idString

The user pool ID.

Returns:

  • (String)


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

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