Skip to content

chore(mixins-preview): update jsdocs with more info about log source set up #36298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShadowCat567 wants to merge 5 commits into
base: main
Choose a base branch
from
+5 −0
Open

chore(mixins-preview): update jsdocs with more info about log source set up #36298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a51d35b
docs update
Dec 4, 2025
b7b3c69
Merge branch 'main' into vendedlogs-jsdocs
ShadowCat567 Dec 4, 2025
d73ea91
fix lint
Dec 4, 2025
238d34e
Merge branch 'vendedlogs-jsdocs' of github.com:aws/aws-cdk into vende…
Dec 4, 2025
4f7af23
update snapshot
Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/@aws-cdk/mixins-preview/scripts/spec2logs/builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
3 changes: 3 additions & 0 deletions packages/@aws-cdk/mixins-preview/test/codegen/__snapshots__/logs-delivery.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)) {
Expand Down
Loading