Skip to content

Commit 1b1395b

Browse files
author
AWS
committed
AmplifyBackend Update: Adding the ability to customize Cognito verification messages for email and SMS in CreateBackendAuth and UpdateBackendAuth. Adding deprecation documentation for ForgotPassword in CreateBackendAuth and UpdateBackendAuth
1 parent 8cdcfa5 commit 1b1395b

File tree

2 files changed

+80
-15
lines changed

2 files changed

+80
-15
lines changed

‎.changes/next-release/feature-AmplifyBackend-37e8893.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AmplifyBackend",
4+
"contributor": "",
5+
"description": "Adding the ability to customize Cognito verification messages for email and SMS in CreateBackendAuth and UpdateBackendAuth. Adding deprecation documentation for ForgotPassword in CreateBackendAuth and UpdateBackendAuth"
6+
}

‎services/amplifybackend/src/main/resources/codegen-resources/service-2.json

+74-15
Original file line numberDiff line numberDiff line change
@@ -1753,20 +1753,20 @@
17531753
"DeliveryMethod": {
17541754
"shape": "DeliveryMethod",
17551755
"locationName": "deliveryMethod",
1756-
"documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>"
1756+
"documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.</p>"
17571757
},
17581758
"EmailSettings": {
17591759
"shape": "EmailSettings",
17601760
"locationName": "emailSettings",
1761-
"documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
1761+
"documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>"
17621762
},
17631763
"SmsSettings": {
17641764
"shape": "SmsSettings",
17651765
"locationName": "smsSettings",
1766-
"documentation": "<p>The configuration for the SMS message sent when an app user forgets their password.</p>"
1766+
"documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an app user forgets their password.</p>"
17671767
}
17681768
},
1769-
"documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>",
1769+
"documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>",
17701770
"required": [
17711771
"DeliveryMethod"
17721772
]
@@ -2001,7 +2001,7 @@
20012001
"ForgotPassword": {
20022002
"shape": "CreateBackendAuthForgotPasswordConfig",
20032003
"locationName": "forgotPassword",
2004-
"documentation": "<p>Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
2004+
"documentation": "<p><b>(DEPRECATED)</b> Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
20052005
},
20062006
"Mfa": {
20072007
"shape": "CreateBackendAuthMFAConfig",
@@ -2032,6 +2032,11 @@
20322032
"shape": "__string",
20332033
"locationName": "userPoolName",
20342034
"documentation": "<p>The Amazon Cognito user pool name.</p>"
2035+
},
2036+
"VerificationMessage": {
2037+
"shape": "CreateBackendAuthVerificationMessageConfig",
2038+
"locationName": "verificationMessage",
2039+
"documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
20352040
}
20362041
},
20372042
"documentation": "<p>Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.</p>",
@@ -2041,6 +2046,30 @@
20412046
"UserPoolName"
20422047
]
20432048
},
2049+
"CreateBackendAuthVerificationMessageConfig": {
2050+
"type": "structure",
2051+
"members": {
2052+
"DeliveryMethod": {
2053+
"shape": "DeliveryMethod",
2054+
"locationName": "deliveryMethod",
2055+
"documentation": "<p>The type of verification message to send.</p>"
2056+
},
2057+
"EmailSettings": {
2058+
"shape": "EmailSettings",
2059+
"locationName": "emailSettings",
2060+
"documentation": "<p>The settings for the email message.</p>"
2061+
},
2062+
"SmsSettings": {
2063+
"shape": "SmsSettings",
2064+
"locationName": "smsSettings",
2065+
"documentation": "<p>The settings for the SMS message.</p>"
2066+
}
2067+
},
2068+
"documentation": "<p>Creates an email or SMS verification message for the auth resource configured for your Amplify project.</p>",
2069+
"required": [
2070+
"DeliveryMethod"
2071+
]
2072+
},
20442073
"CreateBackendConfigReqObj": {
20452074
"type": "structure",
20462075
"members": {
@@ -2147,7 +2176,7 @@
21472176
"ResourceConfig": {
21482177
"shape": "ResourceConfig",
21492178
"locationName": "resourceConfig",
2150-
"documentation": "<p>The resource configuration for creating backend storage.</p>"
2179+
"documentation": "<p>The resource configuration for creating a backend.</p>"
21512180
},
21522181
"ResourceName": {
21532182
"shape": "__string",
@@ -2183,7 +2212,7 @@
21832212
"ResourceConfig": {
21842213
"shape": "ResourceConfig",
21852214
"locationName": "resourceConfig",
2186-
"documentation": "<p>The resource configuration for creating backend storage.</p>"
2215+
"documentation": "<p>The resource configuration for creating a backend.</p>"
21872216
},
21882217
"ResourceName": {
21892218
"shape": "__string",
@@ -2786,6 +2815,7 @@
27862815
},
27872816
"DeliveryMethod": {
27882817
"type": "string",
2818+
"documentation": "<p>The type of verification message to send.</p>",
27892819
"enum": [
27902820
"EMAIL",
27912821
"SMS"
@@ -2797,12 +2827,12 @@
27972827
"EmailMessage": {
27982828
"shape": "__string",
27992829
"locationName": "emailMessage",
2800-
"documentation": "<p>The body of the email.</p>"
2830+
"documentation": "<p>The contents of the email message.</p>"
28012831
},
28022832
"EmailSubject": {
28032833
"shape": "__string",
28042834
"locationName": "emailSubject",
2805-
"documentation": "<p>The subject of the email.</p>"
2835+
"documentation": "<p>The contents of the subject line of the email message.</p>"
28062836
}
28072837
},
28082838
"documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
@@ -4229,7 +4259,7 @@
42294259
"SmsMessage": {
42304260
"shape": "__string",
42314261
"locationName": "smsMessage",
4232-
"documentation": "<p>The body of the SMS message.</p>"
4262+
"documentation": "<p>The contents of the SMS message.</p>"
42334263
}
42344264
},
42354265
"documentation": "<p>SMS settings for authentication.</p>"
@@ -4353,20 +4383,20 @@
43534383
"DeliveryMethod": {
43544384
"shape": "DeliveryMethod",
43554385
"locationName": "deliveryMethod",
4356-
"documentation": "<p>Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
4386+
"documentation": "<p><b>(DEPRECATED)</b> Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.</p>"
43574387
},
43584388
"EmailSettings": {
43594389
"shape": "EmailSettings",
43604390
"locationName": "emailSettings",
4361-
"documentation": "<p>The configuration for the email sent when an app user forgets their password.</p>"
4391+
"documentation": "<p><b>(DEPRECATED)</b> The configuration for the email sent when an app user forgets their password.</p>"
43624392
},
43634393
"SmsSettings": {
43644394
"shape": "SmsSettings",
43654395
"locationName": "smsSettings",
4366-
"documentation": "<p>The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
4396+
"documentation": "<p><b>(DEPRECATED)</b> The configuration for the SMS message sent when an Amplify app user forgets their password.</p>"
43674397
}
43684398
},
4369-
"documentation": "<p>Describes the forgot password policy for authenticating into the Amplify app.</p>"
4399+
"documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for authenticating into the Amplify app.</p>"
43704400
},
43714401
"UpdateBackendAuthIdentityPoolConfig": {
43724402
"type": "structure",
@@ -4572,7 +4602,7 @@
45724602
"ForgotPassword": {
45734603
"shape": "UpdateBackendAuthForgotPasswordConfig",
45744604
"locationName": "forgotPassword",
4575-
"documentation": "<p>Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
4605+
"documentation": "<p><b>(DEPRECATED)</b> Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
45764606
},
45774607
"Mfa": {
45784608
"shape": "UpdateBackendAuthMFAConfig",
@@ -4588,10 +4618,39 @@
45884618
"shape": "UpdateBackendAuthPasswordPolicyConfig",
45894619
"locationName": "passwordPolicy",
45904620
"documentation": "<p>Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
4621+
},
4622+
"VerificationMessage": {
4623+
"shape": "UpdateBackendAuthVerificationMessageConfig",
4624+
"locationName": "verificationMessage",
4625+
"documentation": "<p>Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.</p>"
45914626
}
45924627
},
45934628
"documentation": "<p>Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.</p>"
45944629
},
4630+
"UpdateBackendAuthVerificationMessageConfig": {
4631+
"type": "structure",
4632+
"members": {
4633+
"DeliveryMethod": {
4634+
"shape": "DeliveryMethod",
4635+
"locationName": "deliveryMethod",
4636+
"documentation": "<p>The type of verification message to send.</p>"
4637+
},
4638+
"EmailSettings": {
4639+
"shape": "EmailSettings",
4640+
"locationName": "emailSettings",
4641+
"documentation": "<p>The settings for the email message.</p>"
4642+
},
4643+
"SmsSettings": {
4644+
"shape": "SmsSettings",
4645+
"locationName": "smsSettings",
4646+
"documentation": "<p>The settings for the SMS message.</p>"
4647+
}
4648+
},
4649+
"documentation": "<p>Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.</p>",
4650+
"required": [
4651+
"DeliveryMethod"
4652+
]
4653+
},
45954654
"UpdateBackendConfigReqObj": {
45964655
"type": "structure",
45974656
"members": {

0 commit comments

Comments
 (0)