Amazon Cognito · JSON Structure

User Pools Custom Domain Config Type Structure

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Type: object Properties: 1 Required: 1
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

CertificateArn

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-custom-domain-config-type-structure.json",
  "name": "CustomDomainConfigType",
  "description": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.",
  "type": "object",
  "properties": {
    "CertificateArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnType"
        },
        {
          "description": "The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain."
        }
      ]
    }
  },
  "required": [
    "CertificateArn"
  ]
}