com.pepperize.cdk.vpc.package-info Maven / Gradle / Ivy

Go to download
/**
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
CDK Vpc
 * 
 * Utility constructs for tagging subnets or creating a cheaper vpc.
 * 

 * 

 * Cheaper Vpc
 * Tagging subnets
 * 
 * 
 * 
Install
 * 
 * 
TypeScript
 * 
 * 
 * npm install @pepperize/cdk-vpc
 * 
 * 
 * or
 * 

 * 
 * yarn add @pepperize/cdk-vpc
 * 
 * 
 * 
Python
 * 
 * 
 * pip install pepperize.cdk-vpc
 * 
 * 
 * 
C# / .Net
 * 
 * 
 * dotnet add package Pepperize.CDK.Vpc
 * 
 * 
 * 
Java
 * 
 * 
 * <dependency>
 *   <groupId>com.pepperize</groupId>
 *   <artifactId>cdk-vpc</artifactId>
 *   <version>${cdkVpc.version}</version>
 * </dependency>
 * 
 * 
 * 
Getting Started
 * 
 * 

 * Create a new CDK TypeScript App project with projen
 * 
 * 
 * mkdir my-project
 * cd my-project
 * git init -b main
 * npx projen new awscdk-app-ts
 * 
 * Add @pepperize/cdk-vpc to your dependencies in .projenrc.js
 * 
 * 
 * const project = new awscdk.AwsCdkTypeScriptApp({
 *   //...
 *   deps: ["@pepperize/cdk-vpc"],
 * });
 * 
 * Install the dependency
 * 
 * 
 * npx projen
 * 
 * 
 * 
 * 
Usage
 * 
 * 
Create a cheaper Vpc
 * 
 * Use this as a cheaper drop-in replacement to create a vpc with 2 AvailabilityZones and a t3.nano NatInstance.
 * 

 * 
 * import { App, Stack } from "aws-cdk-lib";
 * import { CheapVpc } from "@pepperize/cdk-vpc";
 * 
 * const app = new App();
 * const stack = new Stack(app, "MyCheapVpcStack");
 * 
 * new CheapVpc(stack, "MyCheapVpc");
 * 
 * 
 * 
Tag your imported subnets
 * 
 * Subnets imported by Vpc.fromLookup wouldn't be tagged by Tags.of automatically. To tag them (or any other imported vpc resource) use:
 * 

 * 
 * import { CheapVpc } from "@pepperize/cdk-vpc";
 * import * as ec2 from "aws-cdk-lib/aws-ec2";
 * 
 * const app = new App();
 * const stack = new Stack(app, "VpcStack");
 * const vpc = ec2.Vpc.fromLookup(stack, "VpcLookup", {
 *   vpcId: "vpc-1234567890",
 *   region: env.region,
 * });
 * 
 * new CreateTags(vpcStack, "TagPrivateSubnets", {
 *   resourceIds: vpc.privateSubnets.map((subnet) => {
 *     return subnet.subnetId;
 *   }),
 *   tags: [
 *     {
 *       key: "kubernetes.io/role/internal-elb",
 *       value: "1",
 *     },
 *   ],
 * });
 * 
 * 
 * 
Contributing
 * 
 * Contributions of all kinds are welcome :rocket: Check out our contributor's guide.
 * 

 * For a quick start, check out a development environment:
 * 

 * 
 * git clone git@github.com:pepperize/cdk-vpc
 * cd cdk-vpc
 *  # install dependencies
 * yarn
 * # build with projen
 * yarn build
 * 
 */
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
package com.pepperize.cdk.vpc;