Skip to content

Commit 1a05f16

Browse files
author
awstools
committed
docs(client-amplify): Doc only update to Amplify to explain platform setting for Next.js 14 SSG only applications
1 parent e01c9b0 commit 1a05f16

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

clients/client-amplify/src/models/models_0.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,11 @@ export interface CreateAppRequest {
241241
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
242242
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
243243
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
244+
* <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set
245+
* the platform type to <code>WEB_COMPUTE</code> and set the artifacts
246+
* <code>baseDirectory</code> to <code>.next</code> in the application's build
247+
* settings. For an example of the build specification settings, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14">Amplify build
248+
* settings for a Next.js 14 SSG application</a> in the <i>Amplify Hosting User Guide</i>.</p>
244249
* @public
245250
*/
246251
platform?: Platform;
@@ -463,6 +468,8 @@ export interface App {
463468
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
464469
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
465470
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
471+
* <p>If you are deploying an SSG only app with Next.js 14 or later, you must use the
472+
* platform type <code>WEB_COMPUTE</code>.</p>
466473
* @public
467474
*/
468475
platform: Platform | undefined;
@@ -2867,6 +2874,8 @@ export interface UpdateAppRequest {
28672874
* <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
28682875
* type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
28692876
* support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
2877+
* <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set
2878+
* the platform type to <code>WEB_COMPUTE</code>.</p>
28702879
* @public
28712880
*/
28722881
platform?: Platform;

codegen/sdk-codegen/aws-models/amplify.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,7 @@
10931093
"platform": {
10941094
"target": "com.amazonaws.amplify#Platform",
10951095
"traits": {
1096-
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>",
1096+
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>\n <p>If you are deploying an SSG only app with Next.js 14 or later, you must use the\n platform type <code>WEB_COMPUTE</code>.</p>",
10971097
"smithy.api#required": {}
10981098
}
10991099
},
@@ -1981,7 +1981,7 @@
19811981
"platform": {
19821982
"target": "com.amazonaws.amplify#Platform",
19831983
"traits": {
1984-
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>"
1984+
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>\n <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to <code>WEB_COMPUTE</code> and set the artifacts\n <code>baseDirectory</code> to <code>.next</code> in the application's build\n settings. For an example of the build specification settings, see <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14\">Amplify build\n settings for a Next.js 14 SSG application</a> in the <i>Amplify Hosting User Guide</i>.</p>"
19851985
}
19861986
},
19871987
"iamServiceRoleArn": {
@@ -6113,7 +6113,7 @@
61136113
"platform": {
61146114
"target": "com.amazonaws.amplify#Platform",
61156115
"traits": {
6116-
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>"
6116+
"smithy.api#documentation": "<p>The platform for the Amplify app. For a static app, set the platform type to\n <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform\n type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>\n <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to <code>WEB_COMPUTE</code>.</p>"
61176117
}
61186118
},
61196119
"iamServiceRoleArn": {

0 commit comments

Comments
 (0)