Merge branch 'main' into gen1-recommend-parseAmplifyConfig

Author: ashwinkumar6

cspell.json

@@ -641,6 +641,7 @@
     "frontend",
     "frontends",
     "fullheight",
+    "fullname",
     "Gapi",
     "ge",
     "geo_point",

src/pages/[platform]/build-a-backend/add-aws-services/predictions/set-up-predictions/index.mdx

@@ -155,7 +155,7 @@ Import and load the configuration file in your app. It is recommended you add th
 ```ts title="src/main.ts"
 import { Amplify } from "aws-amplify";
 import { parseAmplifyConfig } from "aws-amplify/utils";
-import outputs from './amplify_outputs.json';
+import outputs from '../amplify_outputs.json';
 
 const amplifyConfig = parseAmplifyConfig(outputs);
 

src/pages/[platform]/build-a-backend/auth/concepts/external-identity-providers/index.mdx

@@ -314,11 +314,13 @@ export const auth = defineAuth({
 
 ### Attribute mapping
 
-You can map which attributes are mapped between your external identity provider and your users created in Cognito. We will be able to have the best level of protection for developers if we ensure that attribute mappings that would not work are called out by the type system.
+Identity provider (IdP) services store user attributes in different formats. When using external IdPs with Amazon Cognito user pools, attribute mapping allows you to standardize these varying formats into a consistent schema. 
 
-<Callout>
+Learn more about [mapping IdP attributes to user pool profiles and tokens](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html).
+
+<Callout warning>
 
-If you specify an attribute in your authentication resource as required, and it is not allowed for your external providers, signing in with that external provider will cause an error.
+**Note:** When a federated user signs in to your application, a mapping must be present for each attribute that your user pool requires. Additionally, you must also ensure that the target of each attribute mapping is mutable. Amazon Cognito will attempt to update each mapped attribute when a user signs in regardless of whether the latest value already matches the existing information. If these criteria are not met, Amazon Cognito will return an error and the sign in attempt will fail.
 
 </Callout>
 
@@ -330,7 +332,7 @@ import { defineAuth } from '@aws-amplify/backend';
 export const auth = defineAuth({
   loginWith: {
     email: true,
-    externalAuthProviders: {
+    externalProviders: {
       loginWithAmazon: {
         clientId: secret('LOGINWITHAMAZON_CLIENT_ID'),
         clientSecret: secret('LOGINWITHAMAZON_CLIENT_SECRET'),
@@ -359,7 +361,7 @@ import { defineAuth } from '@aws-amplify/backend';
 export const auth = defineAuth({
   loginWith: {
     email: true,
-    externalAuthProviders: {
+    externalProviders: {
       loginWithAmazon: {
         clientId: secret('LOGINWITHAMAZON_CLIENT_ID'),
         clientSecret: secret('LOGINWITHAMAZON_CLIENT_SECRET'),

src/pages/[platform]/build-a-backend/auth/concepts/user-attributes/index.mdx

@@ -63,6 +63,103 @@ export const auth = defineAuth({
 
 User attributes are defined as [Cognito Standard Attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes). Attributes can be configured to be _required_ for user sign-up in addition to whether the values are _mutable_. When configuring your resource to allow your users to login with `email`, an email must be specified for user sign-up and cannot be changed later. However additional attributes can be configured to be optional, and mutable after sign-up.
 
+```ts title="amplify/auth/resource.ts"
+import { defineAuth } from "@aws-amplify/backend";
+
+export const auth = defineAuth({
+  loginWith: {
+    email: true,
+  },
+  userAttributes: {
+    // Maps to Cognito standard attribute 'address'
+    address: {
+      mutable: true,
+      required: true,
+    },
+    // Maps to Cognito standard attribute 'birthdate'
+    birthdate: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'email'
+    email: {
+      mutable: true,
+      required: true,
+    },
+    // Maps to Cognito standard attribute 'family_name'
+    familyName: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'gender'
+    gender: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'given_name'
+    givenName: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'locale'
+    locale: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'middle_name'
+    middleName: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'name'
+    fullname: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'nickname'
+    nickname: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'phone_number'
+    phoneNumber: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'picture'
+    profilePicture: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'preferred_username'
+    preferredUsername: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'profile'
+    profilePage: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'zoneinfo'
+    timezone: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'updated_at'
+    lastUpdateTime: {
+      mutable: true,
+      required: false,
+    },
+    // Maps to Cognito standard attribute 'website'
+    website: {
+      mutable: true,
+      required: false,
+    },
+  },
+});
+```
+
 ## Custom attributes
 
 In addition to the provided standard attributes, you can configure [Custom Attributes](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-custom-attributes). These are attributes that are typically unique to your use case, such as a tenant ID or a user's display name. Custom attributes are identified by the `custom:` prefix:

src/pages/[platform]/build-a-backend/data/custom-business-logic/index.mdx

@@ -510,6 +510,38 @@ safePrint(echoResponse.echo.content);
 ```
 
 </InlineFilter>
+## Supported Argument Types in Custom Operations
+
+Custom operations can accept different types of arguments. Understanding these options helps define flexible and well-structured APIs.
+
+### Defining Arguments in Custom Operations
+
+When defining a custom operation, you can specify arguments using different types:
+
+- **Scalar Fields**: Basic types such as `string`, `integer`, `float`, etc
+- **Custom Types**: Define inline `customType`
+- **Reference Types**: Use `a.ref()` to reference enums and custom types
+
+```ts title="amplify/data/resource.ts"
+const schema = a.schema({
+  Status: a.enum(['ACCEPTED', 'REJECTED']),
+  
+  getPost: a
+    .query()
+    .arguments({
+      // scalar field
+      content: a.string(),
+      // inline custom type
+      config: a.customType({
+        filter: a.string(),
+        // reference to enum
+        status: a.ref('Status')
+      }),
+    })
+    .returns(a.string())
+    .authorization(allow => [allow.authenticated()])
+});
+```
 
 ## Async function handlers
 

src/pages/[platform]/build-a-backend/functions/streaming-logs/index.mdx

@@ -30,7 +30,7 @@ export function getStaticProps(context) {
   };
 }
 
-Amplify enables you to stream logs from your Function directly to your terminal while running [`ampx sandbox`](/[platform]/reference/cli-commands/#npx-ampx-sandbox). To get started, specify the `--stream-function-logs` option when starting sandbox:
+Amplify enables you to stream logs from your AWS Lambda functions directly to your terminal while running [`ampx sandbox`](/[platform]/reference/cli-commands/#npx-ampx-sandbox). To get started, specify the `--stream-function-logs` option when starting sandbox:
 
 ```bash title="Terminal" showLineNumbers={false}
 npx ampx sandbox --stream-function-logs
@@ -42,11 +42,17 @@ npx ampx sandbox --stream-function-logs
 
 </Callout>
 
-Streaming Function logs directly to your terminal enable faster debug iterations, and greater insight into your Functions' executions.
+Streaming function logs directly to your terminal enable faster debug iterations, and greater insight into your functions' executions.
 
 ## Filtering
 
-By default, Amplify will stream all of your Functions' logs. If you wish to only stream a subset of Functions you can specify a filter by Function name or a regular expression for Function names. For example, if you have a collection of [Auth triggers](/[platform]/build-a-backend/auth/customize-auth-lifecycle/triggers/) where the Function names include "auth"
+By default, Amplify will stream all of your functions' logs. If you wish to only stream a subset of functions you can specify a filter by function name or a regular expression for function names. For example, if you have a collection of [Auth triggers](/[platform]/build-a-backend/auth/customize-auth-lifecycle/triggers/) where the function names include "auth".
+
+<Callout info>
+
+When working with more than 5 functions, we recommend using the `--logs-filter` flag to filter the log output to specific functions.
+
+</Callout>
 
 ```bash title="Terminal" showLineNumbers={false}
 npx ampx sandbox --stream-function-logs --logs-filter auth
@@ -89,7 +95,7 @@ By default, Amplify will print logs to the terminal where sandbox is running, ho
 npx ampx sandbox --stream-function-logs --logs-out-file sandbox.log
 ```
 
-This can be combined with `--logs-filter` to create a log file of just your Auth-related Functions, for example:
+This can be combined with `--logs-filter` to create a log file of just your Auth-related functions, for example:
 
 ```bash title="Terminal" showLineNumbers={false}
 npx ampx sandbox --stream-function-logs --logs-filter auth --logs-out-file sandbox-auth.log

src/pages/[platform]/deploy-and-host/fullstack-branching/secrets-and-vars/index.mdx

@@ -159,3 +159,7 @@ console.log('REACT_APP_TEST_VARIABLE', process.env.REACT_APP_TEST_VARIABLE);
 ### Local environment
 
 When working on your local machine, you must manually load the sandbox's environment variables. First, add the environment variable in your `.env.local` file. Then, a library such as [`@dotenvx/dotenvx`](https://www.npmjs.com/package/@dotenvx/dotenvx) can load the environment variables, which you can then reference with `process.env`.
+
+```bash title="Terminal" showLineNumbers={false}
+npx dotenvx run --env-file=.env.local -- ampx sandbox
+```

src/pages/[platform]/reference/cli-commands/index.mdx

@@ -332,6 +332,26 @@ npx ampx generate graphql-client-code --format modelgen --type-target angular
 | Modelgen | Amplify Flutter | `amplify codegen model` | `npx ampx generate graphql-client-code --format modelgen --model-target dart --out <path_to_flutter_project>/AmplifyModels` | `<path_to_flutter_project>/AmplifyModels` |
 
 
+## npx ampx generate schema-from-database
+
+Generates typescript data schema from a SQL database.
+
+### Options
+
+- `--stack`(_string_) - A stack name that contains an Amplify backend.
+- `--branch` (_string_) - Name of the git branch being deployed.
+- `--app-id` (_string_) - The app id of the target Amplify app.
+- `--out`(_string_) - A path to directory where generated schema is written [default: `./amplify/data/schema.sql.ts`].
+- `--connection-uri-secret`(_string_) - Amplify secret name for the database connection uri.
+- `--ssl-cert-secret`(_string_) - Amplify secret name for the database ssl certificate.
+- `--profile`(_string_) - An AWS profile name.
+
+### Usage
+
+```bash title="Terminal" showLineNumbers={false}
+npx ampx generate schema-from-database --connection-uri-secret SQL_CONNECTION_STRING --out amplify/data/schema.sql.ts
+```
+
 ## npx ampx generate forms
 
 Generate React form components derived from your backend data models for your frontend application to consume.