Skip to content

Commit 4542da5

Browse files
authored
chore(docs): fix rule wording and grammar (cdklabs#1001)
Updates some of the info and messages across AWS solutions /Hipaa rules. ### Question : - AwsSolutions-OS5: - Should this be `The OpenSearch Service domain allows for unsigned requests or anonymous access.` than ` The OpenSearch Service domain does not allow for unsigned requests or anonymous access.`
1 parent 2fa1981 commit 4542da5

File tree

6 files changed

+33
-33
lines changed

6 files changed

+33
-33
lines changed

RULES.md

+15-15
Large diffs are not rendered by default.

src/packs/aws-solutions.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ export class AwsSolutionsChecks extends NagPack {
223223
ruleSuffixOverride: 'EB1',
224224
info: 'The Elastic Beanstalk environment is not configured to use a specific VPC.',
225225
explanation:
226-
'Use a non-default in order to seperate your environment from default resources.',
226+
'Use a non-default VPC in order to seperate your environment from default resources.',
227227
level: NagMessageLevel.ERROR,
228228
rule: ElasticBeanstalkVPCSpecified,
229229
node: node,
@@ -419,7 +419,7 @@ export class AwsSolutionsChecks extends NagPack {
419419
});
420420
this.applyRule({
421421
ruleSuffixOverride: 'S3',
422-
info: 'The S3 Bucket does not default encryption enabled.',
422+
info: 'The S3 Bucket does not have default encryption enabled.',
423423
explanation:
424424
'The bucket should minimally have SSE enabled to help protect data-at-rest.',
425425
level: NagMessageLevel.ERROR,
@@ -616,7 +616,7 @@ export class AwsSolutionsChecks extends NagPack {
616616
});
617617
this.applyRule({
618618
ruleSuffixOverride: 'N2',
619-
info: 'The Neptune DB instance does have Auto Minor Version Upgrade enabled.',
619+
info: 'The Neptune DB instance does not have Auto Minor Version Upgrade enabled.',
620620
explanation:
621621
'The Neptune service regularly releases engine updates. Enabling Auto Minor Version Upgrade will allow the service to automatically apply these upgrades to DB Instances.',
622622
level: NagMessageLevel.ERROR,
@@ -867,7 +867,7 @@ export class AwsSolutionsChecks extends NagPack {
867867
});
868868
this.applyRule({
869869
ruleSuffixOverride: 'CFR6',
870-
info: 'The CloudFront distribution does not use an origin access identity an S3 origin.',
870+
info: 'The CloudFront distribution does not use an origin access identity with an S3 origin.',
871871
explanation:
872872
'Origin access identities help with security by restricting any direct access to objects through S3 URLs.',
873873
level: NagMessageLevel.ERROR,
@@ -1062,7 +1062,7 @@ export class AwsSolutionsChecks extends NagPack {
10621062
});
10631063
this.applyRule({
10641064
ruleSuffixOverride: 'GL3',
1065-
info: 'The Glue job does not have use a security configuration with job bookmark encryption enabled.',
1065+
info: 'The Glue job does not use a security configuration with job bookmark encryption enabled.',
10661066
explanation:
10671067
'Job bookmark encryption encrypts bookmark data before it is sent to Amazon S3 for storage.',
10681068
level: NagMessageLevel.WARN,
@@ -1080,7 +1080,7 @@ export class AwsSolutionsChecks extends NagPack {
10801080
});
10811081
this.applyRule({
10821082
ruleSuffixOverride: 'KDF1',
1083-
info: 'The Kinesis Data Firehose delivery stream does have server-side encryption enabled.',
1083+
info: 'The Kinesis Data Firehose delivery stream does not have server-side encryption enabled.',
10841084
explanation:
10851085
'This allows the system to meet strict regulatory requirements and enhance the security of system data.',
10861086
level: NagMessageLevel.ERROR,
@@ -1170,7 +1170,7 @@ export class AwsSolutionsChecks extends NagPack {
11701170
});
11711171
this.applyRule({
11721172
ruleSuffixOverride: 'OS5',
1173-
info: 'The OpenSearch Service domain does not allow for unsigned requests or anonymous access.',
1173+
info: 'The OpenSearch Service domain allows for unsigned requests or anonymous access.',
11741174
explanation:
11751175
'Restricting public access helps prevent unauthorized access and prevents any unsigned requests to be made to the resources.',
11761176
level: NagMessageLevel.ERROR,
@@ -1291,7 +1291,7 @@ export class AwsSolutionsChecks extends NagPack {
12911291
ruleSuffixOverride: 'KMS5',
12921292
info: 'The KMS Symmetric key does not have automatic key rotation enabled.',
12931293
explanation:
1294-
'KMS key rotation allow a system to set an yearly rotation schedule for a KMS key so when a AWS KMS key is required to encrypt new data, the KMS service can automatically use the latest version of the HSA backing key to perform the encryption.',
1294+
'KMS key rotation allows a system to set an yearly rotation schedule for a KMS key so when an AWS KMS key is required to encrypt new data, the KMS service can automatically use the latest version of the HSA backing key to perform the encryption.',
12951295
level: NagMessageLevel.ERROR,
12961296
rule: KMSBackingKeyRotationEnabled,
12971297
node: node,
@@ -1315,7 +1315,7 @@ export class AwsSolutionsChecks extends NagPack {
13151315
private checkServerless(node: CfnResource): void {
13161316
this.applyRule({
13171317
ruleSuffixOverride: 'ASC3',
1318-
info: 'The GraphQL API does not have request leveling logging enabled.',
1318+
info: 'The GraphQL API does not have request level logging enabled.',
13191319
explanation:
13201320
'It is important to use CloudWatch Logs to log metrics such as who has accessed the GraphQL API, how the caller accessed the API, and invalid requests.',
13211321
level: NagMessageLevel.ERROR,

src/packs/hipaa-security.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,9 @@ export class HIPAASecurityChecks extends NagPack {
310310
node: node,
311311
});
312312
this.applyRule({
313-
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAUTH - (Control IDs: 164.308(a)(3)(i), 164.308(a)(4)(ii)(A), 164.308(a)(4)(ii)(C), 164.312(a)(1)).',
313+
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAuth - (Control IDs: 164.308(a)(3)(i), 164.308(a)(4)(ii)(A), 164.308(a)(4)(ii)(C), 164.312(a)(1)).',
314314
explanation:
315-
'OAUTH is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
315+
'OAuth is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
316316
level: NagMessageLevel.ERROR,
317317
rule: CodeBuildProjectSourceRepoUrl,
318318
node: node,
@@ -750,7 +750,7 @@ export class HIPAASecurityChecks extends NagPack {
750750
node: node,
751751
});
752752
this.applyRule({
753-
info: 'The RDS DB instance does not enhanced monitoring enabled - (Control ID: 164.312(b)).',
753+
info: 'The RDS DB instance does not have enhanced monitoring enabled - (Control ID: 164.312(b)).',
754754
explanation:
755755
'Enable enhanced monitoring to help monitor Amazon RDS availability. This provides detailed visibility into the health of your Amazon RDS database instances.',
756756
level: NagMessageLevel.ERROR,

src/packs/nist-800-53-r4.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,9 @@ export class NIST80053R4Checks extends NagPack {
260260
node: node,
261261
});
262262
this.applyRule({
263-
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAUTH - (Control ID: SA-3(a)).',
263+
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAuth - (Control ID: SA-3(a)).',
264264
explanation:
265-
'OAUTH is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
265+
'OAuth is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
266266
level: NagMessageLevel.ERROR,
267267
rule: CodeBuildProjectSourceRepoUrl,
268268
node: node,
@@ -623,7 +623,7 @@ export class NIST80053R4Checks extends NagPack {
623623
*/
624624
private checkRDS(node: CfnResource): void {
625625
this.applyRule({
626-
info: 'The RDS DB instance does not enhanced monitoring enabled - (Control ID: CA-7(a)(b)).',
626+
info: 'The RDS DB instance does not have enhanced monitoring enabled - (Control ID: CA-7(a)(b)).',
627627
explanation:
628628
'Enable enhanced monitoring to help monitor Amazon RDS availability. This provides detailed visibility into the health of your Amazon RDS database instances.',
629629
level: NagMessageLevel.ERROR,

src/packs/nist-800-53-r5.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ export class NIST80053R5Checks extends NagPack {
693693
*/
694694
private checkRDS(node: CfnResource): void {
695695
this.applyRule({
696-
info: 'The RDS DB Instance does not enhanced monitoring enabled - (Control IDs: AU-12(3), AU-14a, AU-14b, CA-2(2), CA-7, CA-7b, PM-14a.1, PM-14b, PM-31, SC-36(1)(a), SI-2a).',
696+
info: 'The RDS DB Instance does not have enhanced monitoring enabled - (Control IDs: AU-12(3), AU-14a, AU-14b, CA-2(2), CA-7, CA-7b, PM-14a.1, PM-14b, PM-31, SC-36(1)(a), SI-2a).',
697697
explanation:
698698
'Enable enhanced monitoring to help monitor Amazon RDS availability. This provides detailed visibility into the health of your Amazon RDS database instances.',
699699
level: NagMessageLevel.ERROR,

src/packs/pci-dss-321.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,9 @@ export class PCIDSS321Checks extends NagPack {
276276
node: node,
277277
});
278278
this.applyRule({
279-
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAUTH - (Control ID: 8.2.1).',
279+
info: 'The CodeBuild project which utilizes either a GitHub or BitBucket source repository does not utilize OAuth - (Control ID: 8.2.1).',
280280
explanation:
281-
'OAUTH is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
281+
'OAuth is the most secure method of authenticating your CodeBuild application. Use OAuth instead of personal access tokens or a user name and password to grant authorization for accessing GitHub or Bitbucket repositories.',
282282
level: NagMessageLevel.ERROR,
283283
rule: CodeBuildProjectSourceRepoUrl,
284284
node: node,

0 commit comments

Comments
 (0)