From 1a05f160f507d87ecaa2135ef0b4dac1661526c4 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 13 Sep 2024 18:12:06 +0000 Subject: [PATCH] docs(client-amplify): Doc only update to Amplify to explain platform setting for Next.js 14 SSG only applications --- clients/client-amplify/src/models/models_0.ts | 9 +++++++++ codegen/sdk-codegen/aws-models/amplify.json | 6 +++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/clients/client-amplify/src/models/models_0.ts b/clients/client-amplify/src/models/models_0.ts index da7ac1995253..31e733166019 100644 --- 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 { * WEB. For a dynamic server-side rendered (SSR) app, set the platform * type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR * support only, set the platform type to WEB_DYNAMIC.

+ *

If you are deploying an SSG only app with Next.js version 14 or later, you must set + * the platform type to WEB_COMPUTE and set the artifacts + * baseDirectory to .next in the application's build + * settings. For an example of the build specification settings, see Amplify build + * settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

* @public */ platform?: Platform; @@ -463,6 +468,8 @@ export interface App { * WEB. For a dynamic server-side rendered (SSR) app, set the platform * type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR * support only, set the platform type to WEB_DYNAMIC.

+ *

If you are deploying an SSG only app with Next.js 14 or later, you must use the + * platform type WEB_COMPUTE.

* @public */ platform: Platform | undefined; @@ -2867,6 +2874,8 @@ export interface UpdateAppRequest { * WEB. For a dynamic server-side rendered (SSR) app, set the platform * type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR * support only, set the platform type to WEB_DYNAMIC.

+ *

If you are deploying an SSG only app with Next.js version 14 or later, you must set + * the platform type to WEB_COMPUTE.

* @public */ platform?: Platform; diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json index 34bab28a6eea..0a561cf8f4a4 100644 --- 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": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

", + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

\n

If you are deploying an SSG only app with Next.js 14 or later, you must use the\n platform type WEB_COMPUTE.

", "smithy.api#required": {} } }, @@ -1981,7 +1981,7 @@ "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

\n

If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to WEB_COMPUTE and set the artifacts\n baseDirectory to .next in the application's build\n settings. For an example of the build specification settings, see Amplify build\n settings for a Next.js 14 SSG application in the Amplify Hosting User Guide.

" } }, "iamServiceRoleArn": { @@ -6113,7 +6113,7 @@ "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to\n WEB. For a dynamic server-side rendered (SSR) app, set the platform\n type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR\n support only, set the platform type to WEB_DYNAMIC.

\n

If you are deploying an SSG only app with Next.js version 14 or later, you must set\n the platform type to WEB_COMPUTE.

" } }, "iamServiceRoleArn": {