Skip to content

Commit e2e06b3

Browse files
author
AWS
committed
AWS Amplify Update: Add ComputeRoleArn to CreateApp, UpdateApp, CreateBranch, and UpdateBranch, allowing caller to specify a role to be assumed by Amplify Hosting for server-side rendered applications.
1 parent 96c3904 commit e2e06b3

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Amplify",
4+
"contributor": "",
5+
"description": "Add ComputeRoleArn to CreateApp, UpdateApp, CreateBranch, and UpdateBranch, allowing caller to specify a role to be assumed by Amplify Hosting for server-side rendered applications."
6+
}

services/amplify/src/main/resources/codegen-resources/service-2.json

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -689,9 +689,13 @@
689689
"shape":"UpdateTime",
690690
"documentation":"<p>A timestamp of when Amplify updated the application.</p>"
691691
},
692+
"computeRoleArn":{
693+
"shape":"ComputeRoleArn",
694+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
695+
},
692696
"iamServiceRoleArn":{
693697
"shape":"ServiceRoleArn",
694-
"documentation":"<p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. </p>"
698+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>"
695699
},
696700
"environmentVariables":{
697701
"shape":"EnvironmentVariables",
@@ -1098,7 +1102,11 @@
10981102
"shape":"BackendEnvironmentArn",
10991103
"documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p> <p>This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
11001104
},
1101-
"backend":{"shape":"Backend"}
1105+
"backend":{"shape":"Backend"},
1106+
"computeRoleArn":{
1107+
"shape":"ComputeRoleArn",
1108+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
1109+
}
11021110
},
11031111
"documentation":"<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>"
11041112
},
@@ -1207,6 +1215,12 @@
12071215
"pattern":"(?s).*"
12081216
},
12091217
"CommitTime":{"type":"timestamp"},
1218+
"ComputeRoleArn":{
1219+
"type":"string",
1220+
"max":1000,
1221+
"min":0,
1222+
"pattern":"(?s).*"
1223+
},
12101224
"Condition":{
12111225
"type":"string",
12121226
"max":2048,
@@ -1234,9 +1248,13 @@
12341248
"shape":"Platform",
12351249
"documentation":"<p>The platform for the Amplify app. For a static app, set the platform type to <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>"
12361250
},
1251+
"computeRoleArn":{
1252+
"shape":"ComputeRoleArn",
1253+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
1254+
},
12371255
"iamServiceRoleArn":{
12381256
"shape":"ServiceRoleArn",
1239-
"documentation":"<p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>"
1257+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>"
12401258
},
12411259
"oauthToken":{
12421260
"shape":"OauthToken",
@@ -1431,6 +1449,10 @@
14311449
"backend":{
14321450
"shape":"Backend",
14331451
"documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
1452+
},
1453+
"computeRoleArn":{
1454+
"shape":"ComputeRoleArn",
1455+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
14341456
}
14351457
},
14361458
"documentation":"<p> The request structure for the create branch request. </p>"
@@ -3271,9 +3293,13 @@
32713293
"shape":"Platform",
32723294
"documentation":"<p>The platform for the Amplify app. For a static app, set the platform type to <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>"
32733295
},
3296+
"computeRoleArn":{
3297+
"shape":"ComputeRoleArn",
3298+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
3299+
},
32743300
"iamServiceRoleArn":{
32753301
"shape":"ServiceRoleArn",
3276-
"documentation":"<p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>"
3302+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>"
32773303
},
32783304
"environmentVariables":{
32793305
"shape":"EnvironmentVariables",
@@ -3431,6 +3457,10 @@
34313457
"backend":{
34323458
"shape":"Backend",
34333459
"documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
3460+
},
3461+
"computeRoleArn":{
3462+
"shape":"ComputeRoleArn",
3463+
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>"
34343464
}
34353465
},
34363466
"documentation":"<p>The request structure for the update branch request. </p>"

0 commit comments

Comments
 (0)