aws-amplify · Jay2113 · Mar 12, 2024 · Mar 11, 2024
@@ -1,6 +1,6 @@
 ## Build a backend
 
-Next, we will add data and auth capabilities to the app.  In Amplify (Gen 2), the `resource.ts` files are where you _define_ the corresponding backend resource and details about it.
+Next, we will add data and auth capabilities to the app.  In Amplify Gen 2, the `resource.ts` files are where you _define_ the corresponding backend resource and details about it.
 
 ### Add data
 

@@ -13,7 +13,7 @@ export function getStaticProps(context) {
 
 <Callout warning>
 
-**Under active development:** The `addOutput` method for Amplify (Gen 2) is under active development. The experience may change between versions of `@aws-amplify/backend`. Try it out and provide feedback at https://github.com/aws-amplify/amplify-backend/issues/new/choose
+**Under active development:** The `addOutput` method for Amplify Gen 2 is under active development. The experience may change between versions of `@aws-amplify/backend`. Try it out and provide feedback at https://github.com/aws-amplify/amplify-backend/issues/new/choose
 
 </Callout>
 

@@ -18,7 +18,7 @@ Custom resources allow you to integrate any AWS service into an Amplify backend.
 
 </Callout>
 
-With Amplify (Gen 2), you can add custom AWS resources to an Amplify app using the [AWS Cloud Development Kit (AWS CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html), which is installed by default as part of the [`create-amplify`](https://www.npmjs.com/package/create-amplify) workflow. The AWS CDK is an open source software development framework that defines your cloud application resources using familiar programming languages, such as TypeScript.
+With Amplify Gen 2, you can add custom AWS resources to an Amplify app using the [AWS Cloud Development Kit (AWS CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html), which is installed by default as part of the [`create-amplify`](https://www.npmjs.com/package/create-amplify) workflow. The AWS CDK is an open source software development framework that defines your cloud application resources using familiar programming languages, such as TypeScript.
 
 The AWS CDK can be used within an Amplify app to add custom resources and configurations beyond what Amplify supports out of the box. For example, a developer could use CDK to hook up a Redis cache, implement custom security rules, deploy containers on AWS Fargate, or use any other AWS service.
 

@@ -13,7 +13,7 @@ export function getStaticProps(context) {
 
 <Callout warning>
 
-**Under active development:** The `addOutput` method for Amplify (Gen 2) is under active development. The experience may change between versions of `@aws-amplify/backend`. Try it out and provide feedback at https://github.com/aws-amplify/amplify-backend/issues/new/choose
+**Under active development:** The `addOutput` method for Amplify Gen 2 is under active development. The experience may change between versions of `@aws-amplify/backend`. Try it out and provide feedback at https://github.com/aws-amplify/amplify-backend/issues/new/choose
 
 </Callout>
 

@@ -15,7 +15,7 @@ You can enable the use of sign-in with social providers using the `amplify/auth/
 
 In this guide we will review how you can add sign-in with social providers by first setting up your developer account with the provider. After this step, you can then configure your Auth category and integrate social sign-in with your app.
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 <Accordion title='Review how OAuth authentication works' headingLevel='3' eyebrow='Learn more'>
 
@@ -283,7 +283,7 @@ export const auth = defineAuth({
 ## Set up your frontend
 
 <Callout info>
-If you are using the [Authenticator component](https://ui.docs.amplify.aws/react/connected-components/authenticator/configuration#social-providers) with Amplify (Gen 2), this feature works without any additional code. The guide below is for writing your own implementation.
+If you are using the [Authenticator component](https://ui.docs.amplify.aws/react/connected-components/authenticator/configuration#social-providers) with Amplify Gen 2, this feature works without any additional code. The guide below is for writing your own implementation.
 </Callout>
 
 Enabling a signing in of a user with a social provider can be done as shown in the following code snippet.

@@ -12,4 +12,4 @@ export function getStaticProps(context) {
 
 }
 
-We do not yet have out-of-the-box support for Admin queries in Amplify (Gen 2). You will have to a create a new [AWS Lambda](https://aws.amazon.com/lambda/) resource, and provide it with the necessary permissions to access the [Amazon Cognito Admin Actions](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_Operations.html) behind the scenes.
+We do not yet have out-of-the-box support for Admin queries in Amplify Gen 2. You will have to a create a new [AWS Lambda](https://aws.amazon.com/lambda/) resource, and provide it with the necessary permissions to access the [Amazon Cognito Admin Actions](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_Operations.html) behind the scenes.
@@ -14,7 +14,7 @@ export function getStaticProps(context) {
 
 Tapping into auth events allows you to react to user flows in real time and trigger custom business logic. For example, you may want to capture data, synchronize your app's state, and personalize the user's experience. You can listen to and respond to events across the Auth lifecycle such as sign-in and sign-out. In this guide we will describe how you can listen to these auth events.
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 ## Expose hub events triggered in response to auth actions
 

@@ -15,7 +15,7 @@ export function getStaticProps(context) {
 
 Empowering users to delete their account can improve trust and transparency. You can programmatically enable self-service account deletion with Amplify Auth.
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 ## Allow my users to delete their account
 

@@ -62,7 +62,7 @@ When enabling MFA you will have two key decisions to make:
 <Callout info>
   If you are using the [Authenticator
   component](https://ui.docs.amplify.aws/react/connected-components/authenticator)
-  with Amplify (Gen 2), this feature works without any additional code. The
+  with Amplify Gen 2, this feature works without any additional code. The
   guide below is for writing your own implementation.
 </Callout>
 
@@ -261,7 +261,7 @@ async function handleUpdateMFAPreference() {
 <Callout info>
   If you are using the [Authenticator
   component](https://ui.docs.amplify.aws/react/connected-components/authenticator)
-  with Amplify (Gen 2), this feature works without any additional code. The
+  with Amplify Gen 2, this feature works without any additional code. The
   guide below is for writing your own implementation.
 </Callout>
 

@@ -13,7 +13,7 @@ export function getStaticProps(context) {
 
 User profile management helps you keep your applications secure while also personalizing your app experiences. In this guide we will review how you can enable your users to personalize their profile and verify their contact information. This includes outlining how you can set up user attributes, verify them, and allow your users to delete them when necessary.
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 ## Set up user attributes
 

@@ -13,7 +13,7 @@ export function getStaticProps(context) {
 
 Amplify Auth provides access to current user sessions and tokens to help you retrieve your user's information to determine if they are signed in with a valid session and control their access to your app. You can manage tokens and expiration times and revoke sessions. In this guide we will review how to retrieve your user's session and understand what token management options are available.
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 ## Retrieve your current authenticated user
 

@@ -14,7 +14,7 @@ export function getStaticProps(context) {
 
 Amplify Auth provides a secure way for your users to change their password or recover a forgotten password. 
 
-If you have not yet created an Amplify (Gen 2) app, visit the [quickstart](/gen2/start/quickstart).
+If you have not yet created an Amplify Gen 2 app, visit the [quickstart](/gen2/start/quickstart).
 
 ## Understand password default settings
 

@@ -12,7 +12,7 @@ export function getStaticProps(context) {
   };
 }
 
-This guide walks you through how to create a trunk-based, multi-region deployment pipeline for applications built using AWS Amplify (Gen 2). We will be using Amazon CodeCatalyst and AWS Amplify Hosting in this guide, but you can choose any CI/CD provider.
+This guide walks you through how to create a trunk-based, multi-region deployment pipeline for applications built using AWS Amplify Gen 2. We will be using Amazon CodeCatalyst and AWS Amplify Hosting in this guide, but you can choose any CI/CD provider.
 
 <Callout info>
 
@@ -24,31 +24,31 @@ This guide walks you through how to create a trunk-based, multi-region deploymen
 
 Please refer to this Amazon CodeCatalyst [guide](https://docs.aws.amazon.com/codecatalyst/latest/userguide/setting-up-topnode.html) for a detailed step-by-step walkthrough to set up your [space](https://docs.aws.amazon.com/codecatalyst/latest/userguide/spaces.html).
 
-### Step 2: Deploy an app using Amplify (Gen 2)
+### Step 2: Deploy an app using Amplify Gen 2
 
 - Sign in to the [AWS Management Console](https://console.aws.amazon.com/).
-- Navigate to the [app creation page](https://us-west-2.console.aws.amazon.com/amplify/create) for Amplify (Gen 2).
+- Navigate to the [app creation page](https://us-west-2.console.aws.amazon.com/amplify/create) for Amplify Gen 2.
 - Select the **Next.js-Amplify starter** app, then select **Next**.
 - Review the details on the **Create Git Repository** page, then select **Save and deploy**.
-- Done! You have successfully deployed a Gen-2 app. You can review the status of the app deployment in the Amplify (Gen 2) console.
+- Done! You have successfully deployed a Gen 2 app. You can review the status of the app deployment in the Amplify Gen 2 console.
 
-![Screenshot of completed deployment in AWS Amplify (Gen 2) console](images/gen2/cross-account-deployments/pipeline1.png)
+![Screenshot of completed deployment in AWS Amplify Gen 2 console](images/gen2/cross-account-deployments/pipeline1.png)
 
 ### Step 3: Update build specification
 
 Add the `npx amplify generate config --branch $AWS_BRANCH --app-id $AWS_APP_ID` command to the build spec and comment out the `npx amplify pipeline-deploy --branch $AWS_BRANCH --app-id $AWS_APP_ID` command. `amplify pipeline-deploy` runs a script to deploy backend updates, while `amplify generate config` fetches the latest `amplifyconfiguration.json` for the specified environment.
 
-![Screenshot of Build image settings section in AWS Amplify (Gen 2) console, with details about the app build specification](images/gen2/cross-account-deployments/pipeline10.png)
+![Screenshot of Build image settings section in AWS Amplify Gen 2 console, with details about the app build specification](images/gen2/cross-account-deployments/pipeline10.png)
 
 ### Step 4: Disable automatic builds on the branch
 
-You can configure Amplify to disable automatic builds on every code commit. Navigate to the app in the Amplify (Gen 2) console. Under **App settings**, select **Repository settings**. From the **Branches** section, select the branch and then choose **Disable auto build** from the **Actions** dropdown menu.
+You can configure Amplify to disable automatic builds on every code commit. Navigate to the app in the Amplify Gen 2 console. Under **App settings**, select **Repository settings**. From the **Branches** section, select the branch and then choose **Disable auto build** from the **Actions** dropdown menu.
 
-![Screenshot of the Repository settings section in the Amplify (Gen 2) console, highlighting the selection of Disable auto build in the Actions dropdown menu](images/gen2/cross-account-deployments/pipeline9.png)
+![Screenshot of the Repository settings section in the Amplify Gen 2 console, highlighting the selection of Disable auto build in the Actions dropdown menu](images/gen2/cross-account-deployments/pipeline9.png)
 
 ### Step 5: Create an incoming webhook
 
-You can set up an incoming webhook to trigger a build without committing code to your Git repository. Currently, the Amplify (Gen 2) console does not support creation of incoming webhooks. However, you can create a webhook for a Gen-2 app using the AWS CLI by running the [`create-webhook`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/amplify/create-webhook.html) command:
+You can set up an incoming webhook to trigger a build without committing code to your Git repository. Currently, the Amplify Gen 2 console does not support creation of incoming webhooks. However, you can create a webhook for a Gen 2 app using the AWS CLI by running the [`create-webhook`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/amplify/create-webhook.html) command:
 
 ```bash
 aws amplify create-webhook --app-id <value> --branch-name <value> --region <value>
@@ -81,7 +81,7 @@ Please refer to this Amazon CodeCatalyst [guide](https://docs.aws.amazon.com/cod
 
 <Callout info>
 
-**Note**: When creating your project, select the **amplify-nextjs-starter-app** GitHub repository, which we used to deploy the Gen-2 app in Step 2.
+**Note**: When creating your project, select the **amplify-nextjs-starter-app** GitHub repository, which we used to deploy the Gen 2 app in Step 2.
 
 </Callout>
 
@@ -97,7 +97,7 @@ Navigate to the CodeCatalyst space created as part of Step 1, select **Settings*
 
 ![Screenshot of CodeCatalyst console showing details of the Associate AWS account section](images/gen2/cross-account-deployments/pipeline12.png)
 
-You will also need to create an IAM role in the target AWS account which will be assumed by the `staging` environment to perform actions and deploy resources in the `production` environment. As a best practice, we recommend attaching the [`AmplifyBackendDeployFullAccess`](https://docs.aws.amazon.com/amplify/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AmplifyBackendDeployFullAccess) AWS managed policy to the IAM role as it contains all the required permissions to deploy Gen-2 resources in your account. You can learn more about adding IAM roles to account connections in the CodeCatalyst [documentation](https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-connect-account-addroles.html).
+You will also need to create an IAM role in the target AWS account which will be assumed by the `staging` environment to perform actions and deploy resources in the `production` environment. As a best practice, we recommend attaching the [`AmplifyBackendDeployFullAccess`](https://docs.aws.amazon.com/amplify/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AmplifyBackendDeployFullAccess) AWS managed policy to the IAM role as it contains all the required permissions to deploy Gen 2 resources in your account. You can learn more about adding IAM roles to account connections in the CodeCatalyst [documentation](https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-connect-account-addroles.html).
 
 ### Step 9: Create a workflow in the Amazon CodeCatalyst project
 
@@ -166,4 +166,4 @@ Next, you can review the result of the workflow run from the **Runs** tab:
 
 ![Screenshot of CodeCatalyst console showing the Workflows section, focusing on the Runs tab](images/gen2/cross-account-deployments/pipeline11.png)
 
-Done! You have successfully set up a custom cross-account pipeline to deploy your frontend and backend for apps built using Amplify (Gen 2). To summarize, this custom pipeline will enable you to deploy your backend initially with your `staging` environment using `amplify pipeline-deploy` in the CodeCatalyst workflow and `amplify generate config` will generate the `amplifyconfiguration.json` file for the `main` branch. Amplify Hosting will not deploy backend resources as part of the build and instead will use the deployed backend resources from the `main` branch. Once the staging environment deploys successfully, a similar process will be followed to deploy your `production` environment in a different AWS account.
+Done! You have successfully set up a custom cross-account pipeline to deploy your frontend and backend for apps built using Amplify Gen 2. To summarize, this custom pipeline will enable you to deploy your backend initially with your `staging` environment using `amplify pipeline-deploy` in the CodeCatalyst workflow and `amplify generate config` will generate the `amplifyconfiguration.json` file for the `main` branch. Amplify Hosting will not deploy backend resources as part of the build and instead will use the deployed backend resources from the `main` branch. Once the staging environment deploys successfully, a similar process will be followed to deploy your `production` environment in a different AWS account.
@@ -12,13 +12,13 @@ export function getStaticProps(context) {
 
 }
 
-While building with Amplify CI/CD offers benefits such as zero-config setup, fullstack previews, centralized secrets management, Amplify (Gen 2) makes it easy to integrate fullstack CI/CD into your custom pipelines (for example, AWS CodePipeline, Amazon CodeCatalyst, GitHub Actions, and more).
+While building with Amplify CI/CD offers benefits such as zero-config setup, fullstack previews, centralized secrets management, Amplify Gen 2 makes it easy to integrate fullstack CI/CD into your custom pipelines (for example, AWS CodePipeline, Amazon CodeCatalyst, GitHub Actions, and more).
 
 ## Set up backend deployments
 
 You can set up your backend deployments using the following steps:
 
-1.  Create an Amplify app by connecting a fullstack Gen-2 branch from your Git repository. This is a one time setup as for subsequent deployments, we will be using a custom pipeline.
+1.  Create an Amplify app by connecting a fullstack Gen 2 branch from your Git repository. This is a one time setup as for subsequent deployments, we will be using a custom pipeline.
 
 2.  Disable Auto-build for your branch. This will ensure code commits to your branch will not trigger a build.
 

@@ -13,7 +13,7 @@ export function getStaticProps(context) {
 
 }
 
-You might have different frontend and backend teams that maintain their own repositories. With Amplify (Gen 2), you can deploy repositories that have backend-only code, so frontend and backend teams can operate independently of each other.
+You might have different frontend and backend teams that maintain their own repositories. With Amplify Gen 2, you can deploy repositories that have backend-only code, so frontend and backend teams can operate independently of each other.
 
 ## Deploy the backend app