Skip to content

Commit 2ee5be3

Browse files
chore: change outputs to amplifyConfig in flutter gen 2 docs (#7764)
* chore: change outputs to amplifyConfig in flutter gen 2 docs * chore: change amplifyconfiguration.dart import to amplify_outputs.dart * chore: remove --outputs-version 0 and downgrade config file callout * chore: remove --outputs-version 0 from snippets * chore: remove gen 2 config conversion callout * chore: remove amplifyconfiguration.dart references from gen 2
1 parent be293f5 commit 2ee5be3

File tree

8 files changed

+18
-29
lines changed

8 files changed

+18
-29
lines changed

src/pages/[platform]/build-a-backend/add-aws-services/analytics/record-events/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ However, it can take upwards of 30 minutes for the event to display in the Filte
305305

306306
## Flush events
307307

308-
Events have default configuration to flush out to the network every 30 seconds. If you would like to change this, update `amplifyconfiguration.dart` with the value in milliseconds you would like for `autoFlushEventsInterval`. This configuration will flush events every 10 seconds:
308+
Events have default configuration to flush out to the network every 30 seconds. If you would like to change this, update `amplify_outputs.dart` with the value in milliseconds you would like for `autoFlushEventsInterval`. This configuration will flush events every 10 seconds:
309309

310310
```json
311311
{

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
300300
import 'package:amplify_flutter/amplify_flutter.dart';
301301
import 'package:flutter/material.dart';
302302
303-
import 'amplifyconfiguration.dart';
303+
import 'amplify_outputs.dart';
304304
305305
Future<void> _configureAmplify() async {
306306
// Add Pinpoint and Cognito Plugins, and any other plugins you want to use
@@ -316,15 +316,15 @@ When running your app on macOS you will need to enable keychain sharing in Xcode
316316

317317
</Callout>
318318

319-
Make sure that the amplifyconfiguration.dart file generated in the project setup is included and sent to Amplify.configure:
319+
Make sure that the amplify_outputs.dart file generated in the project setup is included and sent to Amplify.configure:
320320

321321
```dart
322322
import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart';
323323
import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
324324
import 'package:amplify_flutter/amplify_flutter.dart';
325325
import 'package:flutter/material.dart';
326326
327-
import 'amplifyconfiguration.dart';
327+
import 'amplify_outputs.dart';
328328
329329
Future<void> _configureAmplify() async {
330330
// ...
@@ -333,7 +333,7 @@ Future<void> _configureAmplify() async {
333333
// Once Plugins are added, configure Amplify
334334
// Note: Amplify can only be configured once.
335335
try {
336-
await Amplify.configure(outputs);
336+
await Amplify.configure(amplifyConfig);
337337
} on AmplifyAlreadyConfiguredException {
338338
safePrint(
339339
'Tried to reconfigure Amplify; this can occur when your app restarts on Android.',
@@ -350,7 +350,7 @@ import 'package:amplify_analytics_pinpoint/amplify_analytics_pinpoint.dart';
350350
import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
351351
import 'package:flutter/material.dart';
352352
353-
import 'amplifyconfiguration.dart';
353+
import 'amplify_outputs.dart';
354354
355355
Future<void> _configureAmplify() async {
356356
// Add any Amplify plugins you want to use
@@ -361,7 +361,7 @@ Future<void> _configureAmplify() async {
361361
// Once Plugins are added, configure Amplify
362362
// Note: Amplify can only be configured once.
363363
try {
364-
await Amplify.configure(outputs);
364+
await Amplify.configure(amplifyConfig);
365365
} on AmplifyAlreadyConfiguredException {
366366
safePrint(
367367
'Tried to reconfigure Amplify; this can occur when your app restarts on Android.',

src/pages/[platform]/build-a-backend/auth/set-up-auth/index.mdx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,9 @@ npx ampx sandbox
6969
<InlineFilter filters={['flutter']}>
7070

7171
```bash title="Terminal" showLineNumbers={false}
72-
npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0
72+
npx ampx sandbox --outputs-format dart --outputs-out-dir lib
7373
```
7474

75-
<Callout info>
76-
77-
**Note:** when using Amplify Gen 2 with Flutter, you must downgrade the generated client configuration file (`amplify_outputs.dart`) with [`--outputs-version 0`](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs)
78-
79-
</Callout>
80-
8175
</InlineFilter>
8276
<InlineFilter filters={['android']}>
8377

@@ -394,7 +388,7 @@ import 'package:amplify_authenticator/amplify_authenticator.dart';
394388
import 'package:amplify_flutter/amplify_flutter.dart';
395389
import 'package:flutter/material.dart';
396390
397-
import 'amplifyconfiguration.dart';
391+
import 'amplify_outputs.dart';
398392
399393
Future<void> main() async {
400394
try {

src/pages/[platform]/build-a-backend/data/set-up-data/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ import 'package:amplify_flutter/amplify_flutter.dart';
332332
import 'package:flutter/material.dart';
333333
334334
// highlight-start
335-
import 'amplifyconfiguration.dart';
335+
import 'amplify_outputs.dart';
336336
import 'models/ModelProvider.dart';
337337
// highlight-end
338338
@@ -345,7 +345,7 @@ Future<void> main() async {
345345
)
346346
);
347347
await Amplify.addPlugins([api]);
348-
await Amplify.configure(outputs);
348+
await Amplify.configure(amplifyConfig);
349349
350350
safePrint('Successfully configured Amplify');
351351
} on Exception catch (e) {

src/pages/[platform]/build-a-backend/storage/set-up-storage/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ import 'package:amplify_flutter/amplify_flutter.dart';
446446
import 'package:amplify_storage_s3/amplify_storage_s3.dart';
447447
import 'package:flutter/material.dart';
448448
449-
import 'amplifyconfiguration.dart';
449+
import 'amplify_outputs.dart';
450450
451451
Future<void> _configureAmplify() async {
452452
try {
@@ -455,7 +455,7 @@ Future<void> _configureAmplify() async {
455455
await Amplify.addPlugins([auth, storage]);
456456
457457
// call Amplify.configure to use the initialized categories in your app
458-
await Amplify.configure(outputs);
458+
await Amplify.configure(amplifyConfig);
459459
} on Exception catch (e) {
460460
safePrint('An error occurred configuring Amplify: $e');
461461
}

src/pages/[platform]/build-a-backend/storage/use-with-custom-s3/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ To ensure the local **amplify_outputs.json** file is up-to-date, you can run [th
120120

121121
<InlineFilter filters={["flutter"]}>
122122

123-
## Step 3 - Import latest amplifyconfiguration.dart file
123+
## Step 3 - Import latest amplify_outputs.dart file
124124

125-
To ensure the local **amplifyconfiguration.dart** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs).
125+
To ensure the local **amplify_outputs.dart** file is up-to-date, you can run [the npx ampx generate outputs command](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs).
126126

127127
</InlineFilter>
128128

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ npx ampx sandbox
101101

102102
```bash title="Terminal" showLineNumbers={false}
103103
# for Flutter
104-
npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0
104+
npx ampx sandbox --outputs-format dart --outputs-out-dir lib
105105
```
106106

107107
## npx ampx sandbox delete

src/pages/[platform]/start/quickstart/index.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1313,14 +1313,9 @@ npx ampx sandbox
13131313
</InlineFilter>
13141314
<InlineFilter filters={["flutter"]}>
13151315
```bash title="Terminal" showLineNumbers={false}
1316-
npx ampx sandbox --outputs-format dart --outputs-out-dir lib --outputs-version 0
1316+
npx ampx sandbox --outputs-format dart --outputs-out-dir lib
13171317
```
13181318

1319-
<Callout info>
1320-
1321-
**Note:** when using Amplify Gen 2 with Flutter, you must downgrade the generated client configuration file (`amplify_outputs.dart`) with [`--outputs-version 0`](/[platform]/reference/cli-commands/#npx-ampx-generate-outputs)
1322-
1323-
</Callout>
13241319
</InlineFilter>
13251320

13261321
## Adding Authentication
@@ -1358,7 +1353,7 @@ import 'package:amplify_authenticator/amplify_authenticator.dart';
13581353
import 'package:amplify_flutter/amplify_flutter.dart';
13591354
import 'package:flutter/material.dart';
13601355

1361-
import 'amplifyconfiguration.dart';
1356+
import 'amplify_outputs.dart';
13621357

13631358
Future<void> main() async {
13641359
try {

0 commit comments

Comments
 (0)