AWS cdk documentation change
Summary
Fixed code syntax formatting (angle brackets, backticks) and adjusted punctuation in documentation about CDK Aspects.
Security assessment
Changes are purely syntactic (e.g., replacing bold text with code formatting for 'synth'). While the example discusses enforcing S3 bucket versioning (a security best practice), the changes do not introduce new security documentation or address a specific security vulnerability. The existing security-related example remains unchanged in substance.
Diff
diff --git a/cdk/v2/guide/aspects.md b/cdk/v2/guide/aspects.md index 3007ac2d0..8ab85da82 100644 --- a//cdk/v2/guide/aspects.md +++ b//cdk/v2/guide/aspects.md @@ -13 +13 @@ Aspects are a way to apply an operation to all constructs in a given scope. The -To apply an aspect to a construct and all constructs in the same scope, call [`Aspects`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Aspects.html#static-ofscope)`.of(`SCOPE`).add()` with a new aspect, as shown in the following example. +To apply an aspect to a construct and all constructs in the same scope, call ` [Aspects](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Aspects.html#static-ofscope).of(<SCOPE>).add()` with a new aspect, as shown in the following example. @@ -67 +67 @@ JavaScript -JavaScript doesn't have interfaces as a language feature. Therefore, an aspect is simply an instance of a class having a `visit` method that accepts the node to be operated on. +JavaScript doesn’t have interfaces as a language feature. Therefore, an aspect is simply an instance of a class having a `visit` method that accepts the node to be operated on. @@ -72 +72 @@ Python -Python doesn't have interfaces as a language feature. Therefore, an aspect is simply an instance of a class having a `visit` method that accepts the node to be operated on. +Python doesn’t have interfaces as a language feature. Therefore, an aspect is simply an instance of a class having a `visit` method that accepts the node to be operated on. @@ -99 +99 @@ Go -When you call `Aspects.of(`SCOPE`).add(...)`, the construct adds the aspect to an internal list of aspects. You can obtain the list with `Aspects.of(`SCOPE`)`. +When you call `Aspects.of(<SCOPE>).add(…)`, the construct adds the aspect to an internal list of aspects. You can obtain the list with `Aspects.of(<SCOPE>)`. @@ -105 +105 @@ The `visit` method is free to change anything in the construct. In strongly type -Aspects don't propagate across `Stage` construct boundaries, because `Stages` are self-contained and immutable after definition. Apply aspects on the `Stage` construct itself (or lower) if you want them to visit constructs inside the `Stage`. +Aspects don’t propagate across `Stage` construct boundaries, because `Stages` are self-contained and immutable after definition. Apply aspects on the `Stage` construct itself (or lower) if you want them to visit constructs inside the `Stage`. @@ -109 +109 @@ Aspects don't propagate across `Stage` construct boundaries, because `Stages` ar -The following example validates that all buckets created in the stack have versioning enabled. The aspect adds an error annotation to the constructs that fail the validation. This results in the **synth** operation failing and prevents deploying the resulting cloud assembly. +The following example validates that all buckets created in the stack have versioning enabled. The aspect adds an error annotation to the constructs that fail the validation. This results in the `synth` operation failing and prevents deploying the resulting cloud assembly.