<trigger> | Defines Lambda triggers for your Cognito User Pool. The available trigger names are CreateAuthChallenge , CustomMessage , DefineAuthChallenge , PostAuthentication , PostConfirmation , PreAuthentication , PreSignUp , PreTokenGeneration , UserMigration and VerifyAuthChallengeResponse . To define multiple triggers, add one per line under your User Pool definition inside app.arc . Each trigger added to your app.arc , upon running arc init , will create a corresponding trigger Lambda folder under src/cognito/ . Check out the AWS documents on how to work with Cognito Lambda Triggers for more details. | CreateAuthChallenge VerifyAuthChallengeResponse |
RecoveryOptions | Defines what recovery options a user has if they forget their password. Available options are admin_only (admin will have to reset the user's password), verified_email (email-based recovery), and verified_phone_number (phone-based recovery). A maximum of two options may be specified, and order matters! The first options will be used first, then the second option will be used if that fails. If admin_only is specified, any other values will be ignored. | RecoveryOptions verified_phone_number verified_email |
AllowAdminCreateUserOnly | You can choose to only allow administrators to create users or allow users to sign themselves up. | AllowAdminCreateUserOnly true |
AutoVerifiedAttributes | Which attributes will Cognito verify during user signup? Available options are email and phone_number . You may specify either or both. If you don't want auto-verification of either, omit this option. Depending on the options you choose, you may be charged extra! Ensure you familiarize yourself with how this system works by reading AWS' docs on the topic. | AutoVerifiedAttributes email phone_number |
SESARN | The Amazon Resource Name (ARN) of a verified email address in Amazon SES. Cognito will use this address to send emails during signup and account recovery. Since the app.arc format reserves the use of the @ character, make sure you quote the ARN string! | SESARN "arn:aws:ses:us-west-2:123456789091:identity/support@myapp.com" |
FromEmail | Identifies either the sender's email address or the sender's name with their email address. For example, testuser@example.com or Test User <testuser@example.com> . This address appears before the body of the email. If you provide this option, you must also specify SESARN (see above). Since the app.arc format reserves the use of the @ character, make sure you quote the value! | FromEmail "MyAppSupport <support@myapp.com>" |
StandardAttributes | Cognito provides built-in attributes that it will track for each user. You can specify one or more of these using StandardAttributes . Available options are address , birthdate , email , family_name , gender , given_name , locale , middle_name , name , nickname , phone_number , picture , preferred_username , profile , zone_info , updated_at and website . | StandardAttributes name phone_number |
CustomAttribute:<name> | You can also track your own custom attributes for each user. Each custom attribute is composed of a name, type, minimum value (or length, depending on type), maximum value (or length, depending on type) and whether it is mutable. The format for defining custom attributes is CustomAttribute:<name> <type> <min> <max> <mutable> . This plugin currently supports types of String or Number . If a type of String is provided, <min> and <max> define the minimum and maximum length of the string. If a type of Number is provided, <min> and <max> define the minimum and maximum value of the number. <mutable> is a boolean. | CustomAttribute:FavouriteColour String 2 20 true |
UsernameAttributes | Determines whether email addresses or phone numbers can be specified as user names when a user signs up. Possible values are phone_number or email , and either or both can be provided. | UsernameAttributes email |
UsernameCaseSensitive | Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs. | UsernameCaseSensitive false |