diff --git a/packages/@aws-cdk/mixins-preview/scripts/spec2logs/builder.ts b/packages/@aws-cdk/mixins-preview/scripts/spec2logs/builder.ts index 0f108b150cfb2..0ab9681287657 100644 --- a/packages/@aws-cdk/mixins-preview/scripts/spec2logs/builder.ts +++ b/packages/@aws-cdk/mixins-preview/scripts/spec2logs/builder.ts @@ -357,6 +357,8 @@ class LogsMixin extends ClassType { const resource = method.addParameter({ name: 'resource', type: CONSTRUCTS.IConstruct, + documentation: 'Some configuration may be required on the source resource to get Vended Logs to function properly.' + + `\nSee Vended Logs documentation specific to ${this.resource.cloudFormationType} for more information.`, }); const sourceArn = expr.ident('sourceArn'); diff --git a/packages/@aws-cdk/mixins-preview/test/codegen/__snapshots__/logs-delivery.test.ts.snap b/packages/@aws-cdk/mixins-preview/test/codegen/__snapshots__/logs-delivery.test.ts.snap index 3f4c87063a6e4..71890a5aa30e8 100644 --- a/packages/@aws-cdk/mixins-preview/test/codegen/__snapshots__/logs-delivery.test.ts.snap +++ b/packages/@aws-cdk/mixins-preview/test/codegen/__snapshots__/logs-delivery.test.ts.snap @@ -122,6 +122,9 @@ export class CfnThingLogsMixin extends core.Mixin implements core.IMixin { /** * Apply vended logs configuration to the construct + * + * @param resource Some configuration may be required on the source resource to get Vended Logs to function properly. + * See Vended Logs documentation specific to AWS::Some::Resource for more information. */ public applyTo(resource: constructs.IConstruct): constructs.IConstruct { if (!this.supports(resource)) {