docs(client-amplify): Doc only update to Amplify to explain platform …

…setting for Next.js 14 SSG only applications
aws · Sep 13, 2024 · 1a05f16 · 1a05f16
1 parent e01c9b0
commit 1a05f16
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/clients/client-amplify/src/models/models_0.ts b/clients/client-amplify/src/models/models_0.ts
@@ -241,6 +241,11 @@ export interface CreateAppRequest {
    *                 <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
    *             type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
    *             support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
+   *          <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set
+   *             the platform type to <code>WEB_COMPUTE</code> and set the artifacts
+   *                 <code>baseDirectory</code> to <code>.next</code> in the application's build
+   *             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
+   *                 settings for a Next.js 14 SSG application</a> in the <i>Amplify Hosting User Guide</i>.</p>
    * @public
    */
   platform?: Platform;
@@ -463,6 +468,8 @@ export interface App {
    *                 <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
    *             type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
    *             support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
+   *          <p>If you are deploying an SSG only app with Next.js 14 or later, you must use the
+   *             platform type <code>WEB_COMPUTE</code>.</p>
    * @public
    */
   platform: Platform | undefined;
@@ -2867,6 +2874,8 @@ export interface UpdateAppRequest {
    *                 <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
    *             type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
    *             support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
+   *          <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set
+   *             the platform type to <code>WEB_COMPUTE</code>.</p>
    * @public
    */
   platform?: Platform;

diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json
@@ -1093,7 +1093,7 @@
         "platform": {
           "target": "com.amazonaws.amplify#Platform",
           "traits": {
-            "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>",
+            "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>",
             "smithy.api#required": {}
           }
         },
@@ -1981,7 +1981,7 @@
         "platform": {
           "target": "com.amazonaws.amplify#Platform",
           "traits": {
-            "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>"
+            "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>"
           }
         },
         "iamServiceRoleArn": {
@@ -6113,7 +6113,7 @@
         "platform": {
           "target": "com.amazonaws.amplify#Platform",
           "traits": {
-            "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>"
+            "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>"
           }
         },
         "iamServiceRoleArn": {