Amazon Cognito · Schema

UserPoolAddOnsType

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
AdvancedSecurityMode object
View JSON Schema on GitHub

JSON Schema

user-pools-user-pool-add-ons-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-user-pool-add-ons-type-schema.json",
  "title": "UserPoolAddOnsType",
  "description": "<p>User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to <code>AUDIT</code>. To configure automatic security responses to risky traffic to your user pool, set to <code>ENFORCED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\">Adding advanced security to a user pool</a>.</p>",
  "type": "object",
  "properties": {
    "AdvancedSecurityMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AdvancedSecurityModeType"
        },
        {
          "description": "The operating mode of advanced security features in your user pool."
        }
      ]
    }
  },
  "required": [
    "AdvancedSecurityMode"
  ]
}