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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateUserPoolDomainRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

The UpdateUserPoolDomain request input.

See Also:

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.

Returns:

#domain ⇒ String

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com.

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

Returns:

  • (String) —

    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.

#user_pool_id ⇒ String

The ID of the user pool that is associated with the custom domain that you are updating the certificate for.

Returns:

  • (String) —

    The ID of the user pool that is associated with the custom domain that you are updating the certificate for.