Amazon Cognito · JSON Structure

User Pools User Pool Add Ons Type Structure

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.

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

UserPoolAddOnsType 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

AdvancedSecurityMode

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-user-pool-add-ons-type-structure.json",
  "name": "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"
  ]
}