Skip to content

Commit 5858006

Browse files
authored
fix(mixins-preview): service exports are different then in aws-cdk-lib (#36201)
### Issue Fixes #36210 ### Reason for this change `@aws-cdk/mixins-preview` exports services as `aws_s3` (note the underscore). But `aws-cdk-lib` exports them as `aws-s3` (note the dash). The intention was to align how the exports are named for ease of future migration. Better to fix this now. ### Description of changes Renaming `aws_<SERVICE>` to `aws-<service>` and the required update of `cdk-generate-synthetic-examples`. ### Describe any new or updated permissions being added n/a ### Description of how you validated changes test pipeline ### 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 e2bdddd commit 5858006

File tree

6 files changed

+584
-582
lines changed

6 files changed

+584
-582
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"@types/prettier": "2.6.0",
2424
"@yarnpkg/lockfile": "^1.1.0",
2525
"aws-sdk-js-codemod": "^2.4.5",
26-
"cdk-generate-synthetic-examples": "^0.2.36",
26+
"cdk-generate-synthetic-examples": "^0.2.37",
2727
"conventional-changelog-cli": "^2.2.2",
2828
"fs-extra": "^9.1.0",
2929
"graceful-fs": "^4.2.11",

packages/@aws-cdk/mixins-preview/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Configures vended logs delivery for supported resources to various destinations:
140140

141141
```typescript
142142
import '@aws-cdk/mixins-preview/with';
143-
import * as cloudfrontMixins from '@aws-cdk/mixins-preview/aws_cloudfront/mixins';
143+
import * as cloudfrontMixins from '@aws-cdk/mixins-preview/aws-cloudfront/mixins';
144144

145145
// Create CloudFront distribution
146146
declare const bucket: s3.Bucket;
@@ -197,9 +197,9 @@ Mixins.of(bucket).apply(new CfnBucketPropsMixin(
197197
Property mixins are available for all AWS services:
198198

199199
```typescript
200-
import { CfnLogGroupPropsMixin } from '@aws-cdk/mixins-preview/aws_logs/mixins';
201-
import { CfnFunctionPropsMixin } from '@aws-cdk/mixins-preview/aws_lambda/mixins';
202-
import { CfnTablePropsMixin } from '@aws-cdk/mixins-preview/aws_dynamodb/mixins';
200+
import { CfnLogGroupPropsMixin } from '@aws-cdk/mixins-preview/aws-logs/mixins';
201+
import { CfnFunctionPropsMixin } from '@aws-cdk/mixins-preview/aws-lambda/mixins';
202+
import { CfnTablePropsMixin } from '@aws-cdk/mixins-preview/aws-dynamodb/mixins';
203203
```
204204

205205
### Error Handling
@@ -225,7 +225,7 @@ CDK Mixins automatically generates typed EventBridge event patterns for AWS reso
225225
### Event Patterns Basic Usage
226226

227227
```typescript
228-
import { BucketEvents } from '@aws-cdk/mixins-preview/aws_s3/events';
228+
import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
229229
import * as events from 'aws-cdk-lib/aws-events';
230230
import * as targets from 'aws-cdk-lib/aws-events-targets';
231231

@@ -259,7 +259,7 @@ new events.CfnRule(scope, 'CfnRule', {
259259
**Automatic Resource Injection**: Resource identifiers are automatically included in patterns
260260

261261
```typescript
262-
import { BucketEvents } from '@aws-cdk/mixins-preview/aws_s3/events';
262+
import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
263263

264264
declare const bucket: s3.Bucket;
265265
const bucketEvents = BucketEvents.fromBucket(bucket);
@@ -272,7 +272,7 @@ const pattern = bucketEvents.objectCreatedPattern();
272272
**Event Metadata Support**: Control EventBridge pattern metadata
273273

274274
```typescript
275-
import { BucketEvents } from '@aws-cdk/mixins-preview/aws_s3/events';
275+
import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
276276

277277
declare const bucket: s3.Bucket;
278278
const bucketEvents = BucketEvents.fromBucket(bucket);
@@ -299,5 +299,5 @@ Event patterns are generated for EventBridge events available in the AWS Event S
299299
Import events from service-specific modules:
300300

301301
```typescript
302-
import { BucketEvents } from '@aws-cdk/mixins-preview/aws_s3/events';
302+
import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
303303
```

0 commit comments

Comments
 (0)