Skip to content

Commit 33a4a5d

Browse files
authored
chore(tools): update README for spec2cdk with an example (#31935)
Without an example, it feels very difficult to use spec2cdk as you need a `--service` in order for the tool to pick up the temporary-schemas. ### Issue # (if applicable) Not applicable ### Reason for this change Just a usability clarification. ### Description of changes I've updated only the README ### Description of how you validated changes I read the changes in preview for markdown. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent a261c9d commit 33a4a5d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

tools/@aws-cdk/spec2cdk/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ At a code level, import `@aws-cdk/spec2cdk/lib/cfn2ts` for a drop-in replacement
2929
## Temporary Schemas
3030

3131
You can import additional, temporary CloudFormation Registry Schemas to test new functionality that is not yet published in `@aws-cdk/aws-service-spec`.
32-
To do this, drop the schema file into `temporary-schemas/us-east-1` and it will be imported on top of the default model.
32+
To do this, drop the schema file into `temporary-schemas/us-east-1` ([e.g](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-type-schemas.html)). After you add the schema file, run spec2cdk with the specified module and short name.
33+
As an example, if you were updating [AWS::KMS::Key](https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kms), you must run:
34+
`bin/spec2cdk --service AWS::KMS`.
3335

3436
## CLI
3537

0 commit comments

Comments
 (0)