Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-robot-in committed Apr 25, 2022
1 parent 5f26b9f commit bbe6e9b
Showing 1 changed file with 32 additions and 10 deletions.
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export class VPCStack extends Stack {
subnetConfiguration: [],
},
peeringConfigs: {
// when you deployd this stack , it will be create your peering id, this key will be use to get that id and configure route-table as per route
// when you deployed this stack , it will be create your vpc peering id, this key will be use to get that id and configure route-table as per route
"TEST-PEERING": {
peeringVpcId: "vpc-0000",
tags: {
Expand Down Expand Up @@ -100,7 +100,8 @@ export class VPCStack extends Stack {
routes: [
{
routerType: ec2.RouterType.VPC_PEERING_CONNECTION,
destinationCidrBlock: "10.1.0.0/24",
destinationCidrBlock: "<destinationCidrBlock>",
//<Your VPC PeeringConfig KEY, in this example TEST-PEERING will be your ID>
existingVpcPeeringRouteKey: "TEST-PEERING"
}
],
Expand Down Expand Up @@ -152,24 +153,45 @@ app.synth();
```
Please refer [here](/API.md) to check how to use individual resource constructs.
## :clapper: Quick Start
The quick start shows you how to create **AWS-VPC** using this module.
### Prerequisites
- A working [`aws`](https://aws.amazon.com/cli/) CLI installation with access to an account and administrator privileges
- You'll need a recent [NodeJS](https://nodejs.org) installation
To get going you'll need a CDK project. For details please refer to the [detailed guide for CDK](https://docs.aws.amazon.com/cdk/latest/guide/hello_world.html).
Create an empty directory on your system.
```bash
mkdir aws-quick-start-vpc && cd aws-quick-start-vpc
```
Bootstrap your CDK project, we will use TypeScript, but you can switch to any other supported language.
```bash
npx cdk init sample-vpc --language typescript
npx cdk bootstrap
```
Install using NPM:
```
npm install @smallcase/cdk-vpc-module
```
Using yarn
```
yarn add @smallcase/cdk-vpc-module


Bootstrap the environment
```
cdk bootstrap
```
Check the changed which are to be deployed
```bash
~ -> npx cdk diff
```
~ -> cdk diff
Deploy using
```
~ -> cdk deploy
```bash
~ -> npx cdk deploy
```

0 comments on commit bbe6e9b

Please sign in to comment.