Sample code for 30+ languages & platforms
Lua

Amazon Cognito - Create User Pool

See more Amazon Cognito Examples

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

Chilkat Lua Downloads

Lua
local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local rest = chilkat.Rest.new()

local authAws = chilkat.AuthAws.new()
authAws.access_key = "AWS_ACCESS_KEY"
authAws.secret_key = "AWS_SECRET_KEY"
-- Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.region = "us-west-2"
authAws.service_name = "cognito-idp"
-- SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest:set_auth_aws(authAws)

-- URL: https://cognito-idp.us-west-2.amazonaws.com/
local bTls = true
local port = 443
local bAutoReconnect = true
-- Use the same region as specified above.
local success = rest:connect("cognito-idp.us-west-2.amazonaws.com", port, bTls, bAutoReconnect)
if not success then
    print("ConnectFailReason: " .. rest.connect_fail_reason)
    print(rest.last_error_text)
    return
end

-- Note: The above code does not need to be repeatedly called for each REST request.
-- The rest object can be setup once, and then many requests can be sent.  Chilkat will automatically
-- reconnect within a FullRequest* method as needed.  It is only the very first connection that is explicitly
-- made via the Connect method.

-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON

-- The following JSON is sent in the request body.
-- This example wil demonstrate creating a pool with many options specified.
-- The only required JSON member is "PoolName".

-- {
--     "AccountRecoverySetting": {
--       "RecoveryMechanisms": [
--         {
--           "Name": "verified_phone_number",
--           "Priority": 1
--         },
--         {
--           "Name": "verified_email",
--           "Priority": 2
--         }
--       ]
--     },
--     "AdminCreateUserConfig": {
--       "AllowAdminCreateUserOnly": false,
--       "InviteMessageTemplate": {
--         "EmailMessage": "Your username is {username} and temporary password is {####}. ",
--         "EmailSubject": "Your temporary password",
--         "SMSMessage": "Your username is {username} and temporary password is {####}. "
--       },
--       "TemporaryPasswordValidityDays": 7
--     },
--     "AutoVerifiedAttributes": [
--       "email",
--       "phone_number"
--     ],
--     "EmailConfiguration": {
--       "EmailSendingAccount": "DEVELOPER",
--       "From": "joe@example.com",
--       "ReplyToEmailAddress": "joe@example.com",
--       "SourceArn": "arn:aws:ses:us-west-2:954491834127:identity/joe@example.com"
--     },
--     "EmailVerificationMessage": "Your verification code is {####}. ",
--     "EmailVerificationSubject": "Your verification code",
--     "LambdaConfig": {},
--     "MfaConfiguration": "OFF",
--     "PoolName": "MyTestPool",
--     "Policies": {
--       "PasswordPolicy": {
--         "MinimumLength": 8,
--         "RequireLowercase": true,
--         "RequireNumbers": true,
--         "RequireSymbols": true,
--         "RequireUppercase": true,
--         "TemporaryPasswordValidityDays": 7
--       }
--     },
--     "Schema": [
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": false,
--         "Name": "sub",
--         "Required": true,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "1"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "name",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "given_name",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "family_name",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "middle_name",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "nickname",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "preferred_username",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "profile",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "picture",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "website",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "email",
--         "Required": true,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "Boolean",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "email_verified",
--         "Required": false
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "gender",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "birthdate",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "10",
--           "MinLength": "10"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "zoneinfo",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "locale",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "phone_number",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "String",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "address",
--         "Required": false,
--         "StringAttributeConstraints": {
--           "MaxLength": "2048",
--           "MinLength": "0"
--         }
--       },
--       {
--         "AttributeDataType": "Number",
--         "DeveloperOnlyAttribute": false,
--         "Mutable": true,
--         "Name": "updated_at",
--         "NumberAttributeConstraints": {
--           "MinValue": "0"
--         },
--         "Required": false
--       }
--     ],
--     "SmsAuthenticationMessage": "Your verification code is {####}. ",
--     "SmsConfiguration": {
--       "ExternalId": "94b17737-216b-4cf7-a29e-17e990e91300",
--       "SnsCallerArn": "arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role"
--     },
--     "SmsVerificationMessage": "Your verification code is {####}. ",
--     "UsernameConfiguration": {
--       "CaseSensitive": false
--     },
--     "VerificationMessageTemplate": {
--       "DefaultEmailOption": "CONFIRM_WITH_CODE",
--       "EmailMessage": "Your verification code is {####}. ",
--       "EmailSubject": "Your verification code",
--       "SmsMessage": "Your verification code is {####}. "
--     }
--   }
--

local json = chilkat.JsonObject.new()
json:update_string("AccountRecoverySetting.RecoveryMechanisms[0].Name", "verified_phone_number")
json:update_int("AccountRecoverySetting.RecoveryMechanisms[0].Priority", 1)
json:update_string("AccountRecoverySetting.RecoveryMechanisms[1].Name", "verified_email")
json:update_int("AccountRecoverySetting.RecoveryMechanisms[1].Priority", 2)
json:update_bool("AdminCreateUserConfig.AllowAdminCreateUserOnly", false)
json:update_string("AdminCreateUserConfig.InviteMessageTemplate.EmailMessage", "Your username is {username} and temporary password is {####}. ")
json:update_string("AdminCreateUserConfig.InviteMessageTemplate.EmailSubject", "Your temporary password")
json:update_string("AdminCreateUserConfig.InviteMessageTemplate.SMSMessage", "Your username is {username} and temporary password is {####}. ")
json:update_int("AdminCreateUserConfig.TemporaryPasswordValidityDays", 7)
json:update_string("AutoVerifiedAttributes[0]", "email")
json:update_string("AutoVerifiedAttributes[1]", "phone_number")
json:update_string("EmailConfiguration.EmailSendingAccount", "DEVELOPER")
json:update_string("EmailConfiguration.From", "joe@example.com")
json:update_string("EmailConfiguration.ReplyToEmailAddress", "joe@example.com")
json:update_string("EmailConfiguration.SourceArn", "arn:aws:ses:us-west-2:954491834127:identity/joe@example.com")
json:update_string("EmailVerificationMessage", "Your verification code is {####}. ")
json:update_string("EmailVerificationSubject", "Your verification code")
json:update_new_object("LambdaConfig")
json:update_string("MfaConfiguration", "OFF")
json:update_string("PoolName", "MyTestPool")
json:update_int("Policies.PasswordPolicy.MinimumLength", 8)
json:update_bool("Policies.PasswordPolicy.RequireLowercase", true)
json:update_bool("Policies.PasswordPolicy.RequireNumbers", true)
json:update_bool("Policies.PasswordPolicy.RequireSymbols", true)
json:update_bool("Policies.PasswordPolicy.RequireUppercase", true)
json:update_int("Policies.PasswordPolicy.TemporaryPasswordValidityDays", 7)
json:update_string("Schema[0].AttributeDataType", "String")
json:update_bool("Schema[0].DeveloperOnlyAttribute", false)
json:update_bool("Schema[0].Mutable", false)
json:update_string("Schema[0].Name", "sub")
json:update_bool("Schema[0].Required", true)
json:update_string("Schema[0].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[0].StringAttributeConstraints.MinLength", "1")
json:update_string("Schema[1].AttributeDataType", "String")
json:update_bool("Schema[1].DeveloperOnlyAttribute", false)
json:update_bool("Schema[1].Mutable", true)
json:update_string("Schema[1].Name", "name")
json:update_bool("Schema[1].Required", false)
json:update_string("Schema[1].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[1].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[2].AttributeDataType", "String")
json:update_bool("Schema[2].DeveloperOnlyAttribute", false)
json:update_bool("Schema[2].Mutable", true)
json:update_string("Schema[2].Name", "given_name")
json:update_bool("Schema[2].Required", false)
json:update_string("Schema[2].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[2].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[3].AttributeDataType", "String")
json:update_bool("Schema[3].DeveloperOnlyAttribute", false)
json:update_bool("Schema[3].Mutable", true)
json:update_string("Schema[3].Name", "family_name")
json:update_bool("Schema[3].Required", false)
json:update_string("Schema[3].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[3].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[4].AttributeDataType", "String")
json:update_bool("Schema[4].DeveloperOnlyAttribute", false)
json:update_bool("Schema[4].Mutable", true)
json:update_string("Schema[4].Name", "middle_name")
json:update_bool("Schema[4].Required", false)
json:update_string("Schema[4].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[4].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[5].AttributeDataType", "String")
json:update_bool("Schema[5].DeveloperOnlyAttribute", false)
json:update_bool("Schema[5].Mutable", true)
json:update_string("Schema[5].Name", "nickname")
json:update_bool("Schema[5].Required", false)
json:update_string("Schema[5].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[5].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[6].AttributeDataType", "String")
json:update_bool("Schema[6].DeveloperOnlyAttribute", false)
json:update_bool("Schema[6].Mutable", true)
json:update_string("Schema[6].Name", "preferred_username")
json:update_bool("Schema[6].Required", false)
json:update_string("Schema[6].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[6].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[7].AttributeDataType", "String")
json:update_bool("Schema[7].DeveloperOnlyAttribute", false)
json:update_bool("Schema[7].Mutable", true)
json:update_string("Schema[7].Name", "profile")
json:update_bool("Schema[7].Required", false)
json:update_string("Schema[7].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[7].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[8].AttributeDataType", "String")
json:update_bool("Schema[8].DeveloperOnlyAttribute", false)
json:update_bool("Schema[8].Mutable", true)
json:update_string("Schema[8].Name", "picture")
json:update_bool("Schema[8].Required", false)
json:update_string("Schema[8].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[8].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[9].AttributeDataType", "String")
json:update_bool("Schema[9].DeveloperOnlyAttribute", false)
json:update_bool("Schema[9].Mutable", true)
json:update_string("Schema[9].Name", "website")
json:update_bool("Schema[9].Required", false)
json:update_string("Schema[9].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[9].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[10].AttributeDataType", "String")
json:update_bool("Schema[10].DeveloperOnlyAttribute", false)
json:update_bool("Schema[10].Mutable", true)
json:update_string("Schema[10].Name", "email")
json:update_bool("Schema[10].Required", true)
json:update_string("Schema[10].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[10].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[11].AttributeDataType", "Boolean")
json:update_bool("Schema[11].DeveloperOnlyAttribute", false)
json:update_bool("Schema[11].Mutable", true)
json:update_string("Schema[11].Name", "email_verified")
json:update_bool("Schema[11].Required", false)
json:update_string("Schema[12].AttributeDataType", "String")
json:update_bool("Schema[12].DeveloperOnlyAttribute", false)
json:update_bool("Schema[12].Mutable", true)
json:update_string("Schema[12].Name", "gender")
json:update_bool("Schema[12].Required", false)
json:update_string("Schema[12].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[12].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[13].AttributeDataType", "String")
json:update_bool("Schema[13].DeveloperOnlyAttribute", false)
json:update_bool("Schema[13].Mutable", true)
json:update_string("Schema[13].Name", "birthdate")
json:update_bool("Schema[13].Required", false)
json:update_string("Schema[13].StringAttributeConstraints.MaxLength", "10")
json:update_string("Schema[13].StringAttributeConstraints.MinLength", "10")
json:update_string("Schema[14].AttributeDataType", "String")
json:update_bool("Schema[14].DeveloperOnlyAttribute", false)
json:update_bool("Schema[14].Mutable", true)
json:update_string("Schema[14].Name", "zoneinfo")
json:update_bool("Schema[14].Required", false)
json:update_string("Schema[14].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[14].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[15].AttributeDataType", "String")
json:update_bool("Schema[15].DeveloperOnlyAttribute", false)
json:update_bool("Schema[15].Mutable", true)
json:update_string("Schema[15].Name", "locale")
json:update_bool("Schema[15].Required", false)
json:update_string("Schema[15].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[15].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[16].AttributeDataType", "String")
json:update_bool("Schema[16].DeveloperOnlyAttribute", false)
json:update_bool("Schema[16].Mutable", true)
json:update_string("Schema[16].Name", "phone_number")
json:update_bool("Schema[16].Required", false)
json:update_string("Schema[16].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[16].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[17].AttributeDataType", "String")
json:update_bool("Schema[17].DeveloperOnlyAttribute", false)
json:update_bool("Schema[17].Mutable", true)
json:update_string("Schema[17].Name", "address")
json:update_bool("Schema[17].Required", false)
json:update_string("Schema[17].StringAttributeConstraints.MaxLength", "2048")
json:update_string("Schema[17].StringAttributeConstraints.MinLength", "0")
json:update_string("Schema[18].AttributeDataType", "Number")
json:update_bool("Schema[18].DeveloperOnlyAttribute", false)
json:update_bool("Schema[18].Mutable", true)
json:update_string("Schema[18].Name", "updated_at")
json:update_string("Schema[18].NumberAttributeConstraints.MinValue", "0")
json:update_bool("Schema[18].Required", false)
json:update_string("SmsAuthenticationMessage", "Your verification code is {####}. ")

-- Use your own value here:
json:update_string("SmsConfiguration.ExternalId", "94b17737-216b-4cf7-a29e-17e990e91300")
json:update_string("SmsConfiguration.SnsCallerArn", "arn:aws:iam::954491834127:role/service-role/chilkat-SMS-Role")

json:update_string("SmsVerificationMessage", "Your verification code is {####}. ")
json:update_bool("UsernameConfiguration.CaseSensitive", false)
json:update_string("VerificationMessageTemplate.DefaultEmailOption", "CONFIRM_WITH_CODE")
json:update_string("VerificationMessageTemplate.EmailMessage", "Your verification code is {####}. ")
json:update_string("VerificationMessageTemplate.EmailSubject", "Your verification code")
json:update_string("VerificationMessageTemplate.SmsMessage", "Your verification code is {####}. ")

rest:add_header("Content-Type", "application/x-amz-json-1.0")
rest:add_header("X-Amz-Target", "AWSCognitoIdentityProviderService.CreateUserPool")
rest:add_header("Accept-Encoding", "identity")

local sbRequestBody = chilkat.StringBuilder.new()
json:emit_sb(sbRequestBody)
local sbResponseBody = chilkat.StringBuilder.new()
success = rest:full_request_sb("POST", "/", sbRequestBody, sbResponseBody)
if not success then
    print(rest.last_error_text)
    return
end

local respStatusCode = rest.response_status_code
print("response status code = " .. respStatusCode)
if respStatusCode ~= 200 then
    print("Response Status Code = " .. respStatusCode)
    print("Response Header:")
    print(rest.response_header)
    print("Response Body:")
    print(sbResponseBody:get_as_string())
    return
end

local jsonResponse = chilkat.JsonObject.new()
jsonResponse:load_sb(sbResponseBody)

jsonResponse.emit_compact = false
print(jsonResponse:emit())

-- The response is similar to the response at Cognito Describe User Pool