A CDK construct library to create a VPC with public and private subnets.
Project description
Contributing to CDK Construct Toumoro
Examples
Documentation API
Developpement Guide
Naming Conventions
-
Prefixes:
- Cfn for CloudFormation resources.
- Fn for constructs generating CloudFormation functions.
- As for abstract classes.
- I for interfaces.
- Vpc for constructs related to Virtual Private Cloud.
- Lambda for constructs related to AWS Lambda.
- Example: CfnStack, FnSub, Aspects, IVpc, VpcNetwork, LambdaFunction.
-
Construct Names:
- Use descriptive names that reflect the purpose of the construct.
- CamelCase for multi-word names.
- Avoid abbreviations unless they are widely understood.
- Example: BucketStack, RestApiConstruct, DatabaseCluster.
-
Property Names:
- Follow AWS resource naming conventions where applicable.
- Use camelCase for property names.
- Use clear and concise names that reflect the purpose of the property.
- Example: bucketName, vpcId, functionName.
-
Method Names:
- Use verbs or verb phrases to describe actions performed by methods.
- Use camelCase.
- Example: addBucketPolicy, createVpc, invokeLambda.
-
Interface Names:
- Start with an uppercase I.
- Use clear and descriptive names.
- Example: IInstance, ISecurityGroup, IVpc.
-
Module Names:
- Use lowercase with hyphens for separating words.
- Be descriptive but concise.
- Follow a hierarchy if necessary, e.g., aws-cdk.aws_s3 for S3-related constructs.
- Example: aws-cdk.aws_s3, aws-cdk.aws_ec2, aws-cdk.aws_lambda.
-
Variable Names:
- Use descriptive names.
- CamelCase for multi-word names.
- Keep variable names concise but meaningful.
- Example: instanceCount, subnetIds, roleArn.
-
Enum and Constant Names:
- Use uppercase for constants.
- CamelCase for multi-word names.
- Be descriptive about the purpose of the constant or enum.
- Example: MAX_RETRIES, HTTP_STATUS_CODES, VPC_CONFIG.
-
File Names:
- Use lowercase with hyphens for separating words.
- Reflect the content of the file.
- Include version numbers if necessary.
- Example: s3-bucket-stack.ts, vpc-network.ts, lambda-function.ts.
-
Documentation Comments:
- Use JSDoc or similar conventions to provide clear documentation for each construct, method, property, etc.
- Ensure that the documentation is up-to-date and accurately reflects the purpose and usage of the code.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for cdk-vpc-toumoro-projen-1.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b1b36aa1db7cddfef294b028f635df1ffc939dc01ca2b0b087145effb0be35e |
|
MD5 | 4208426c5089f329ae5f7a6d2ef4cdbd |
|
BLAKE2b-256 | 1b7084481c7a0f1a7583825c10459fb2fa9a9c4057aa965fa09145668a7ab373 |
Close
Hashes for cdk_vpc_toumoro_projen-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 893a9c9ceb37877b8b7a55b125485e4e61c36901155103bd8b0926120247bfc3 |
|
MD5 | 7d036705d56ad055c90143263911dae4 |
|
BLAKE2b-256 | c7b5f1f23a9cff817d9a02c90d1703e1ced37c54c0564977f6f425ed7bf7aa60 |