Skip to main content

CDK construct lib

Welcome to Toumoro's AWS Service Wrapper CDK Construct Library! This library is designed to make it easy and efficient to deploy and manage AWS services within your CDK projects. Whether you're provisioning infrastructure for a simple web application or orchestrating a complex cloud-native architecture, this library aims to streamline your development process by providing high-level constructs for common AWS services.

Features

  • Simplified Service Provisioning: Easily create and configure AWS services using intuitive CDK constructs.
  • Best Practices Built-In: Leverage pre-configured settings and defaults based on AWS best practices to ensure reliable and secure deployments.
  • Modular and Extensible: Compose your infrastructure using modular constructs, allowing for flexibility and reusability across projects.

Contributing to CDK Construct Toumoro

Contributing

Examples

Examples

Documentation API

API

Developpement Guide

AWS CDK Design Guidelines

Naming Conventions

  1. 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.
  2. 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: VpcBasic, RdsAuroraMysqlServerLess.
  3. 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.
  4. Method Names:

    • Use verbs or verb phrases to describe actions performed by methods.
    • Use camelCase.
    • Example: addBucketPolicy, createVpc, invokeLambda.
  5. Interface Names:

    • Interfaces begging uppercase I are reserverd to AWS CDK library.
    • Start with an prefix TmI
    • Use clear and descriptive names.
    • Example: TmIInstance, TmISecurityGroup, TmIVpc.
  6. 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.
  7. Variable Names:

    • Use descriptive names.
    • CamelCase for multi-word names.
    • Keep variable names concise but meaningful.
    • Example: instanceCount, subnetIds, roleArn.
  8. 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.
  9. 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.
  10. 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.

Release files for tm-cdk-constructs 0.0.64

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tm-cdk-constructs 0.0.64
File Size Uploaded
tm_cdk_constructs-0.0.64.tar.gz 206.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tm-cdk-constructs 0.0.64
File Interpreter ABI Platform
tm_cdk_constructs-0.0.64-py3-none-any.whl Python 3 none any Details

Total release size: 410.7 kB

Release files / tm_cdk_constructs-0.0.64.tar.gz

Download URL tm_cdk_constructs-0.0.64.tar.gz
Size 206.4 kB
Tags Source
SHA-256 checksum
How to use checksums
d28ca83c9dbe3019e5fdde709e2a095838fa7a620535005ff41580ba23848f47
BLAKE2b-256 checksum
How to use checksums
b57037285025a017746231d12a3d2d2aff6045a4eba1c463aa0f776744a90a6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.14.7

Release files / tm_cdk_constructs-0.0.64-py3-none-any.whl

Download URL tm_cdk_constructs-0.0.64-py3-none-any.whl
Size 204.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b15773e1700260a2d4312c331523a99bab8084357179ac82cafce6543720a940
BLAKE2b-256 checksum
How to use checksums
95f61cfa2d095c8581a905c42e9d26e3aabfa14c70bb7b16c90d9389921c50a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.0.66

2 release files

0.0.65

2 release files

This release

0.0.64 This release

2 release files

0.0.63

2 release files

0.0.62

2 release files

0.0.61

2 release files

0.0.60

2 release files

0.0.59

2 release files

0.0.58

2 release files

0.0.57

2 release files

0.0.56

2 release files

0.0.55

2 release files

0.0.53

2 release files

0.0.52

2 release files

0.0.51

2 release files

0.0.50

2 release files

0.0.49

2 release files

0.0.48

2 release files

0.0.47

2 release files

0.0.46

2 release files

0.0.44

2 release files

0.0.43

2 release files

0.0.42

2 release files

0.0.40

2 release files

0.0.37

2 release files

0.0.36

2 release files

0.0.35

2 release files

0.0.34

2 release files

0.0.33

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page