Skip to content

Commit db057e1

Browse files
authored
docs: fix typos and wording in feature flags description (#35789)
### Issue # (if applicable) Closes #<issue number here>. ### Reason for this change ### Description of changes ### Describe any new or updated permissions being added ### Description of how you validated changes ### 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 75139b2 commit db057e1

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Flags come in three types:
3838
| [@aws-cdk/core:enablePartitionLiterals](#aws-cdkcoreenablepartitionliterals) | Make ARNs concrete if AWS partition is known | 2.38.0 | fix |
3939
| [@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker](#aws-cdkaws-ecsdisableexplicitdeploymentcontrollerforcircuitbreaker) | Avoid setting the "ECS" deployment controller when adding a circuit breaker | 2.51.0 | fix |
4040
| [@aws-cdk/aws-events:eventsTargetQueueSameAccount](#aws-cdkaws-eventseventstargetqueuesameaccount) | Event Rules may only push to encrypted SQS queues in the same account | 2.51.0 | fix |
41-
| [@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName](#aws-cdkaws-iamimportedrolestacksafedefaultpolicyname) | Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in. | 2.60.0 | fix |
41+
| [@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName](#aws-cdkaws-iamimportedrolestacksafedefaultpolicyname) | Enable this feature to create default policy names for imported roles that depend on the stack the role is in. | 2.60.0 | fix |
4242
| [@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy](#aws-cdkaws-s3serveraccesslogsusebucketpolicy) | Use S3 Bucket Policy instead of ACLs for Server Access Logging | 2.60.0 | fix |
4343
| [@aws-cdk/customresources:installLatestAwsSdkDefault](#aws-cdkcustomresourcesinstalllatestawssdkdefault) | Whether to install the latest SDK by default in AwsCustomResource | 2.60.0 | new default |
4444
| [@aws-cdk/aws-route53-patters:useCertificate](#aws-cdkaws-route53-pattersusecertificate) | Use the official `Certificate` resource instead of `DnsValidatedCertificate` | 2.61.0 | new default |
@@ -879,7 +879,7 @@ always apply, regardless of the value of this flag.
879879

880880
### @aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName
881881

882-
*Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in.*
882+
*Enable this feature to create default policy names for imported roles that depend on the stack the role is in.*
883883

884884
Flag type: Backwards incompatible bugfix
885885

@@ -902,7 +902,7 @@ This new implementation creates default policy names based on the constructs nod
902902

903903
Flag type: Backwards incompatible bugfix
904904

905-
Enable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging
905+
Enable this feature flag to use S3 Bucket Policy for granting permission for Server Access Logging
906906
rather than using the canned `LogDeliveryWrite` ACL. ACLs do not work when Object Ownership is
907907
enabled on the bucket.
908908

@@ -1282,7 +1282,7 @@ Set this flag to false for existing mount targets.
12821282
Flag type: New default behavior
12831283

12841284
If this is set, and a `runtime` prop is not passed to, Lambda NodeJs
1285-
functions will us the latest version of the runtime provided by the Lambda
1285+
functions will use the latest version of the runtime provided by the Lambda
12861286
service. Do not use this if you your lambda function is reliant on dependencies
12871287
shipped as part of the runtime environment.
12881288

@@ -1504,7 +1504,7 @@ When this feature flag is disabled, it will keep the root account principal in t
15041504

15051505
Flag type: New default behavior
15061506

1507-
When this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.
1507+
When this feature flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.
15081508

15091509

15101510
| Since | Unset behaves like | Recommended value |
@@ -1755,8 +1755,8 @@ the latest Amazon Linux 2023 version will be used instead of Amazon Linux 2.
17551755

17561756
Flag type: Configuration option
17571757

1758-
Currently, when Aspects are invoked in one single pass of the construct tree.
1759-
This means that the Aspects that create other Aspects are not run and Aspects that create new nodes of the tree sometimes do not inherit their parent Aspects.
1758+
Previously, Aspects were invoked in a single pass of the construct tree.
1759+
This meant that Aspects which created other Aspects were not run, and Aspects that created new nodes in the tree sometimes did not inherit their parent Aspects.
17601760

17611761
When this feature flag is enabled, a stabilization loop is run to recurse the construct tree multiple times when invoking Aspects.
17621762

@@ -1995,7 +1995,7 @@ When enabled, table replica will be default to the removal policy of source tabl
19951995

19961996
Flag type: New default behavior
19971997

1998-
When this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom
1998+
When this feature flag is enabled, the SDK API call response to describe user pool client values will be logged in the custom
19991999
resource lambda function logs.
20002000

20012001
When this feature flag is disabled, the SDK API call response to describe user pool client values will not be logged in the custom
@@ -2174,7 +2174,7 @@ When this feature flag is disabled, a loggroup is created by Lambda service on f
21742174
of the function (existing behavior).
21752175
LogGroups created in this way do not support Tag propagation, Property Injectors, Aspects.
21762176

2177-
DO NOT ENABLE: If you have and existing app defining a lambda function and
2177+
DO NOT ENABLE: If you have an existing app defining a lambda function and
21782178
have not supplied a logGroup or logRetention prop and your lambda function has
21792179
executed at least once, the logGroup has been already created with the same name
21802180
so your deployment will start failing.

packages/aws-cdk-lib/cx-api/lib/features.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -660,7 +660,7 @@ export const FLAGS: Record<string, FlagInfo> = {
660660
//////////////////////////////////////////////////////////////////////
661661
[IAM_IMPORTED_ROLE_STACK_SAFE_DEFAULT_POLICY_NAME]: {
662662
type: FlagType.BugFix,
663-
summary: 'Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in.',
663+
summary: 'Enable this feature to create default policy names for imported roles that depend on the stack the role is in.',
664664
detailsMd: `
665665
Without this, importing the same role in multiple places could lead to the permissions given for one version of the imported role
666666
to overwrite permissions given to the role at a different place where it was imported. This was due to all imported instances
@@ -677,7 +677,7 @@ export const FLAGS: Record<string, FlagInfo> = {
677677
type: FlagType.BugFix,
678678
summary: 'Use S3 Bucket Policy instead of ACLs for Server Access Logging',
679679
detailsMd: `
680-
Enable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging
680+
Enable this feature flag to use S3 Bucket Policy for granting permission for Server Access Logging
681681
rather than using the canned \`LogDeliveryWrite\` ACL. ACLs do not work when Object Ownership is
682682
enabled on the bucket.
683683
@@ -976,7 +976,7 @@ export const FLAGS: Record<string, FlagInfo> = {
976976
summary: 'Enables aws-lambda-nodejs.Function to use the latest available NodeJs runtime as the default',
977977
detailsMd: `
978978
If this is set, and a \`runtime\` prop is not passed to, Lambda NodeJs
979-
functions will us the latest version of the runtime provided by the Lambda
979+
functions will use the latest version of the runtime provided by the Lambda
980980
service. Do not use this if you your lambda function is reliant on dependencies
981981
shipped as part of the runtime environment.
982982
`,
@@ -1162,7 +1162,7 @@ export const FLAGS: Record<string, FlagInfo> = {
11621162
type: FlagType.ApiDefault,
11631163
summary: 'When enabled, remove default deployment alarm settings',
11641164
detailsMd: `
1165-
When this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.
1165+
When this feature flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service.
11661166
`,
11671167
introducedIn: { v2: '2.143.0' },
11681168
recommendedValue: true,
@@ -1415,8 +1415,8 @@ export const FLAGS: Record<string, FlagInfo> = {
14151415
type: FlagType.VisibleContext,
14161416
summary: 'When enabled, a stabilization loop will be run when invoking Aspects during synthesis.',
14171417
detailsMd: `
1418-
Currently, when Aspects are invoked in one single pass of the construct tree.
1419-
This means that the Aspects that create other Aspects are not run and Aspects that create new nodes of the tree sometimes do not inherit their parent Aspects.
1418+
Previously, Aspects were invoked in a single pass of the construct tree.
1419+
This meant that Aspects which created other Aspects were not run, and Aspects that created new nodes in the tree sometimes did not inherit their parent Aspects.
14201420
14211421
When this feature flag is enabled, a stabilization loop is run to recurse the construct tree multiple times when invoking Aspects.
14221422
`,
@@ -1606,7 +1606,7 @@ export const FLAGS: Record<string, FlagInfo> = {
16061606
type: FlagType.ApiDefault,
16071607
summary: 'When disabled, the value of the user pool client secret will not be logged in the custom resource lambda function logs.',
16081608
detailsMd: `
1609-
When this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom
1609+
When this feature flag is enabled, the SDK API call response to describe user pool client values will be logged in the custom
16101610
resource lambda function logs.
16111611
16121612
When this feature flag is disabled, the SDK API call response to describe user pool client values will not be logged in the custom
@@ -1712,7 +1712,7 @@ export const FLAGS: Record<string, FlagInfo> = {
17121712
of the function (existing behavior).
17131713
LogGroups created in this way do not support Tag propagation, Property Injectors, Aspects.
17141714
1715-
DO NOT ENABLE: If you have and existing app defining a lambda function and
1715+
DO NOT ENABLE: If you have an existing app defining a lambda function and
17161716
have not supplied a logGroup or logRetention prop and your lambda function has
17171717
executed at least once, the logGroup has been already created with the same name
17181718
so your deployment will start failing.

0 commit comments

Comments
 (0)