# @aws-cdk/aws-service-spec

> A specification of built-in AWS resources

Latest version **0.1.233** (published 2026-11-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @aws-cdk/aws-service-spec
pnpm add @aws-cdk/aws-service-spec
yarn add @aws-cdk/aws-service-spec
bun add @aws-cdk/aws-service-spec
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.1.233 |
| Published | 2026-11-17 |
| First published | 2023-06-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 43 |
| Maintainers | amzn-oss, aws-cdk-team |

## Links

- npm: https://www.npmjs.com/package/@aws-cdk/aws-service-spec
- Repository: https://github.com/cdklabs/awscdk-service-spec
- Homepage: https://github.com/cdklabs/awscdk-service-spec#readme
- Issues: https://github.com/cdklabs/awscdk-service-spec/issues
- npm.io page: https://npm.io/package/@aws-cdk/aws-service-spec

## Dependencies (2)

- [@cdklabs/tskb](https://npm.io/package/@cdklabs/tskb.md) ^0.0.4
- [@aws-cdk/service-spec-types](https://npm.io/package/@aws-cdk/service-spec-types.md) ^0.0.299

## Recent versions

- 0.1.233 (latest) — 2026-11-17
- 0.1.232 — 2026-11-14
- 0.1.231 — 2026-11-12
- 0.1.230 — 2026-11-11
- 0.1.229 — 2026-11-07
- 0.1.228 — 2026-11-04
- 0.1.227 — 2026-11-02
- 0.1.226 — 2026-10-31
- 0.1.225 — 2026-10-28
- 0.1.224 — 2026-10-24
- 0.1.223 — 2026-10-21
- 0.1.222 — 2026-10-17
- 0.1.221 — 2026-10-14
- 0.1.220 — 2026-10-10
- 0.1.219 — 2026-10-07
- … 285 more at https://npm.io/package/@aws-cdk/aws-service-spec/versions

## README

# AWS Service Spec

This package contains a definition of the AWS Resources available in CloudFormation.

# Patching

Sometimes it is necessary to patch in certain aspects of the CloudFormation schema, as they are not always
properly configured for our use cases. As such, we'll need to create a patch.

You can create a patch by following these steps:

1. Create a new patch file under `build/patches/service-patches/my-module.ts` (or use one of the existing patch files if it is for
the same module).
2. If you created a new file, add it to `build/patches/service-patches/index.ts`.
3. Enter in the exact properties, attributes, resources, etc. that you wish to patch. You can refer to the existing patches for example,
or the example down below:

```ts
import { forResource, fp, registerServicePatches, replaceDefinitionProperty } from './core';
import { patching } from '@aws-cdk/service-spec-importers';

const reason = patching.Reason.sourceIssue('Something in source was wrong');  // many root causes under `patching.Reason`

registerServicePatches(
  forResource('AWS::Service::Construct', (lens) => {
    replaceDefinitionProperty('SomeDefinition', 'SomeProperty', { type: 'integer' }, reason)(lens);
    replaceDefinition(
      'SomeDefinition',
      {
        type: 'string',
        properties : {
          X : {...},
          Y : {...},
          Z : {...},
        },
      },
      reason,
    )(lens);
    addDefinitions({newDefinition: "something something"}, reason)(lens);
    fp.removeFromReadOnlyProperties('AWS::Service::Construct', ['NotAReadOnlyProperty'], reason),
  }),
);
```

If you do not see your patching changes reflected, double check that there is not an existing [legacy patch](https://github.com/cdklabs/awscdk-service-spec/blob/main/sources/CloudFormationResourceSpecification/README.md)
that may be overwriting your changes.

---
_Source: https://npm.io/package/@aws-cdk/aws-service-spec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
