Skip to content

Commit 0bdeadb

Browse files
committed
Create generic CDK README and updated C# specific one
1 parent 5b651a5 commit 0bdeadb

File tree

3 files changed

+38
-18
lines changed

3 files changed

+38
-18
lines changed

cdk/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Deploy the AWS Lambda Power Tuner tool using the CDK
2+
3+
Here you find various CDK projects to deploy the *AWS Lambda Power Tuner* tool using your preferred programming language.
4+
5+
Currently we support
6+
7+
- [TypeScript](typescript/README.md)
8+
- [C#](csharp/README.md)
9+
10+
You can use these projects as a standalone or reuse it within your own CDK projects.
11+
12+
## Prerequisites
13+
14+
- [AWS CDK Toolkit](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install)
15+
- [General prerequisites for CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_prerequisites)
16+
17+
Check also the langauge specific requirements in the respective README.
18+
19+
## Useful commands
20+
21+
Run these commands from the project folders:
22+
23+
* `cdk deploy` deploy this stack to your default AWS account/region
24+
* `cdk diff` compare deployed stack with current state
25+
* `cdk synth` emits the synthesized CloudFormation template
26+
27+
## Deployment
28+
29+
```
30+
cd cdk/csharp
31+
dotnet build
32+
cdk deploy
33+
```

cdk/csharp/README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,15 @@
11
# How to deploy the AWS Lambda Power Tuner tool using the CDK for C#
22

3-
This CDK project deploys the *AWS Lambda Power Tuner* tool.
3+
This CDK project deploys the *AWS Lambda Power Tuner* tool using C#.
44

55
You can use the project as a standalone or reuse it within your own CDK projects.
66

7-
## Prerequisites
7+
## Language specific prerequisites
88

9-
- [AWS CDK Toolkit](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install)
109
- [.NET 8.0 or later](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_prerequisites)
10+
- [Requirements for CDK with C#](https://docs.aws.amazon.com/cdk/v2/guide/work-with-cdk-csharp.html#csharp-prerequisites)
1111

12-
See also the general [prerequisites for CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_prerequisites) projects.
13-
14-
## Deployment
15-
16-
```
17-
cd cdk/csharp
18-
dotnet build
19-
cdk deploy
20-
```
21-
22-
## Useful commands
12+
## Building and testing the app
2313

2414
* `dotnet build` compile this app
2515
* `dotnet test` test this app
26-
* `cdk deploy` deploy this stack to your default AWS account/region
27-
* `cdk diff` compare deployed stack with current state
28-
* `cdk synth` emits the synthesized CloudFormation template

cdk/csharp/tests/Cdk.Tests/TheLambdaPowerTunerStackTest.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public void TestSar()
2626
{ "Location" , new ObjectDict
2727
{
2828
{ "ApplicationId", "arn:aws:serverlessrepo:us-east-1:451282441545:applications/aws-lambda-power-tuning" },
29-
{ "SemanticVersion", "4.3.0" }
29+
{ "SemanticVersion", "4.3.4" }
3030
}
3131
}
3232
}

0 commit comments

Comments
 (0)