Amazon Cognito · JSON Structure

Cognito Idp Update User Pool Domain Request Structure

The UpdateUserPoolDomain request input.

Type: object Properties: 3 Required: 3
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

UpdateUserPoolDomainRequest is a JSON Structure definition published by Amazon Cognito, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Domain UserPoolId CustomDomainConfig

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "Domain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainType"
        },
        {
          "description": "<p>The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be <code>auth.example.com</code>. </p> <p>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.</p>"
        }
      ]
    },
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The ID of the user pool that is associated with the custom domain whose certificate you're updating."
        }
      ]
    },
    "CustomDomainConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomDomainConfigType"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "Domain",
    "UserPoolId",
    "CustomDomainConfig"
  ],
  "description": "The UpdateUserPoolDomain request input.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-update-user-pool-domain-request-structure.json",
  "name": "UpdateUserPoolDomainRequest"
}