https://github.com/cdklabs/cdk-patched-schema-generator

https://github.com/cdklabs/cdk-patched-schema-generator

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/cdklabs/cdk-patched-schema-generator
• Owner: cdklabs
• License: apache-2.0
• Created: 2024-04-30T18:08:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2026-06-03T01:19:18.000Z (13 days ago)
• Last Synced: 2026-06-03T03:14:02.316Z (13 days ago)
• Language: TypeScript
• Size: 153 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Notice: NOTICE

Awesome Lists containing this project

README

          
# CDK Patched Schema Generator

This GitHub action pulls in the latest changes from `@aws-cdk/aws-service-spec` and generates that schema that cdk-from-cfn needs to a CloudFormation template into CDK a App. The action will create two files: `cdk-resources.json` and `cdk-types.json` at the output path provided in the configuration file.

`cdk-resources.json` contains the entire list of resources in the CloudFormation Resource Specification, CloudFormation Registry Schema, SAM Resource Specification, and SAM JSON Schema, contained in [aws-service-spec](https://github.com/cdklabs/awscdk-service-spec).

`cdk-types.json` contains the CDK compatible type information for all properties and attributes of the resources in `cdk-resources.json`, with patches applied and historical types retained when the types change in CloudFormation et all.

This data is pulled from the sources above as well as from Patches, CloudFormation Docs, and Stateful Resources in [aws-service-spec](https://github.com/cdklabs/awscdk-service-spec).

## Usage

Configure an action that runs one per day:

```yaml

on:

  schedule:

    # Cron format: minute hour day month day-of-the-week

    - cron: '0 0 * * *'

jobs:

  generate_schema:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4

        with:

          node-version: '20'

      - uses: cdklabs/cdk-patched-schema-generator@main

        with:

          # Required

          output-path: 

```