Skip to content

Commit 27b0107

Browse files
authored
Removes wording about needing to install the CDK (#6853)
* Removes wording about needing to install the CDK * Add link to package name * Adding link to create-amplify package name
1 parent 16be6b9 commit 27b0107

File tree

2 files changed

+5
-45
lines changed

2 files changed

+5
-45
lines changed

src/pages/gen2/build-a-backend/add-aws-services/custom-resources/index.mdx

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Custom resources allow you to integrate any AWS service into an Amplify backend.
1818

1919
</Callout>
2020

21-
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). The AWS CDK is an open source software development framework that defines your cloud application resources using familiar programming languages, such as TypeScript.
21+
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.
2222

2323
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.
2424

@@ -34,28 +34,7 @@ With the Amplify code-first DX, you can add existing or custom CDK [constructs](
3434

3535
## Adding an existing CDK construct
3636

37-
The AWS CDK comes with [many existing constructs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-construct-library.html) that can be directly added to your Amplify backend. To get started, install the CDK library:
38-
39-
```bash
40-
npm add --save-dev aws-cdk-lib constructs
41-
```
42-
43-
<Callout warning>
44-
45-
Depending on the Node.js package manager you are using, you may encounter warnings where it is now unable to resolve the peer dependency version `@aws-amplify/backend` has on `aws-cdk-lib`. If you encounter a warning similar to the following, re-install the version specified in the warning text:
46-
47-
```
48-
npm WARN Could not resolve dependency:
49-
npm WARN peer aws-cdk-lib@"~2.103.0" from @aws-amplify/[email protected]
50-
npm WARN node_modules/@aws-amplify/backend
51-
npm WARN dev @aws-amplify/backend@"^0.4.0" from the root project
52-
```
53-
54-
Using the sample warning text above, you would need to install `[email protected]`.
55-
56-
</Callout>
57-
58-
For example, to add an [Amazon Simple Queue Service (Amazon SQS)](https://aws.amazon.com/sqs/) queue and an [Amazon Simple Notification Service (Amazon SNS)](https://aws.amazon.com/sns/) topic to your backend, you can add the following to your `amplify/backend.ts` file.
37+
The AWS CDK comes with [many existing constructs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-construct-library.html) that can be directly added to your Amplify backend. For example, to add an [Amazon Simple Queue Service (Amazon SQS)](https://aws.amazon.com/sqs/) queue and an [Amazon Simple Notification Service (Amazon SNS)](https://aws.amazon.com/sns/) topic to your backend, you can add the following to your `amplify/backend.ts` file.
5938

6039
```ts title="amplify/backend.ts"
6140
import * as sns from 'aws-cdk-lib/aws-sns';

src/pages/gen2/build-a-backend/storage/index.mdx

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,13 @@ export function getStaticProps(context) {
1313

1414
<Callout info>
1515

16-
**Coming soon:** The Storage experience for Amplify (Gen 2) is still under development. You can add Amazon S3 to your Amplify (Gen 2) project with AWS CDK.
16+
**Coming soon:** The Storage experience for Amplify (Gen 2) is still under development. You can add Amazon S3 to your Amplify (Gen 2) project with the AWS CDK.
1717

1818
</Callout>
1919

20-
To use Storage today, you must use the [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/). To get started, install the CDK library package:
20+
To use Storage today, you must use the [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/), which is installed by default as part of the [`create-amplify`](https://www.npmjs.com/package/create-amplify) workflow.
2121

22-
```bash
23-
npm add --save-dev aws-cdk-lib
24-
```
25-
26-
<Callout warning>
27-
28-
Depending on the Node.js package manager you are using, you may encounter warnings where it is now unable to resolve the peer dependency version `@aws-amplify/backend` has on `aws-cdk-lib`. If you encounter a warning similar to the following, re-install the version specified in the warning text:
29-
30-
```
31-
npm WARN Could not resolve dependency:
32-
npm WARN peer aws-cdk-lib@"~2.103.0" from @aws-amplify/[email protected]
33-
npm WARN node_modules/@aws-amplify/backend
34-
npm WARN dev @aws-amplify/backend@"^0.4.0" from the root project
35-
```
36-
37-
Using the sample warning text above, you would need to install `[email protected]`.
38-
39-
</Callout>
40-
41-
Next, modify your project's `backend.ts` file to create an Amazon S3 bucket and grant Amplify-generated resources access to read and write:
22+
To get started, modify your project's `backend.ts` file to create an Amazon S3 bucket and grant Amplify-generated resources access to read and write:
4223

4324
```ts title="amplify/backend.ts"
4425
// amplify/backend.ts

0 commit comments

Comments
 (0)