Class: Aws::CognitoIdentityProvider::Types::UpdateUserPoolDomainRequest

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

Overview

The UpdateUserPoolDomain request input.

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 pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

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. Update the RP ID in a [SetUserPoolMfaConfig] request.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html

Returns:



11719
11720
11721
11722
11723
11724
11725
11726
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11719

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

#domain ⇒ String

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be ‘auth.example.com`.

This string can include only lowercase letters, numbers, and hyphens. Don’t use a hyphen for the first or last character. Use periods to separate subdomain names.

Returns:

  • (String) 


11719
11720
11721
11722
11723
11724
11725
11726
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11719

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

#managed_login_version ⇒ Integer

A version number that indicates the state of managed login for your domain. Version ‘1` is hosted UI (classic). Version `2` is the newer managed login with the branding designer. For more information, see [Managed login].

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

Returns:

  • (Integer) 


11719
11720
11721
11722
11723
11724
11725
11726
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11719

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

#user_pool_id ⇒ String

The ID of the user pool that is associated with the custom domain whose certificate you’re updating.

Returns:

  • (String) 


11719
11720
11721
11722
11723
11724
11725
11726
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11719

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