diff --git a/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md b/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md index 8ab0df6a6cc59..c3816c2d88357 100644 --- a/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md +++ b/packages/aws-cdk-lib/cx-api/FEATURE_FLAGS.md @@ -38,7 +38,7 @@ Flags come in three types: | [@aws-cdk/core:enablePartitionLiterals](#aws-cdkcoreenablepartitionliterals) | Make ARNs concrete if AWS partition is known | 2.38.0 | fix | | [@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker](#aws-cdkaws-ecsdisableexplicitdeploymentcontrollerforcircuitbreaker) | Avoid setting the "ECS" deployment controller when adding a circuit breaker | 2.51.0 | fix | | [@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 | -| [@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 | +| [@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 | | [@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy](#aws-cdkaws-s3serveraccesslogsusebucketpolicy) | Use S3 Bucket Policy instead of ACLs for Server Access Logging | 2.60.0 | fix | | [@aws-cdk/customresources:installLatestAwsSdkDefault](#aws-cdkcustomresourcesinstalllatestawssdkdefault) | Whether to install the latest SDK by default in AwsCustomResource | 2.60.0 | new default | | [@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. ### @aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName -*Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in.* +*Enable this feature to create default policy names for imported roles that depend on the stack the role is in.* Flag type: Backwards incompatible bugfix @@ -902,7 +902,7 @@ This new implementation creates default policy names based on the constructs nod Flag type: Backwards incompatible bugfix -Enable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging +Enable this feature flag to use S3 Bucket Policy for granting permission for Server Access Logging rather than using the canned `LogDeliveryWrite` ACL. ACLs do not work when Object Ownership is enabled on the bucket. @@ -1282,7 +1282,7 @@ Set this flag to false for existing mount targets. Flag type: New default behavior If this is set, and a `runtime` prop is not passed to, Lambda NodeJs -functions will us the latest version of the runtime provided by the Lambda +functions will use the latest version of the runtime provided by the Lambda service. Do not use this if you your lambda function is reliant on dependencies shipped as part of the runtime environment. @@ -1504,7 +1504,7 @@ When this feature flag is disabled, it will keep the root account principal in t Flag type: New default behavior -When this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service. +When this feature flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service. | Since | Unset behaves like | Recommended value | @@ -1755,8 +1755,8 @@ the latest Amazon Linux 2023 version will be used instead of Amazon Linux 2. Flag type: Configuration option -Currently, when Aspects are invoked in one single pass of the construct tree. -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. +Previously, Aspects were invoked in a single pass of the construct tree. +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. When this feature flag is enabled, a stabilization loop is run to recurse the construct tree multiple times when invoking Aspects. @@ -1995,7 +1995,7 @@ When enabled, table replica will be default to the removal policy of source tabl Flag type: New default behavior -When this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom +When this feature flag is enabled, the SDK API call response to describe user pool client values will be logged in the custom resource lambda function logs. 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 of the function (existing behavior). LogGroups created in this way do not support Tag propagation, Property Injectors, Aspects. -DO NOT ENABLE: If you have and existing app defining a lambda function and +DO NOT ENABLE: If you have an existing app defining a lambda function and have not supplied a logGroup or logRetention prop and your lambda function has executed at least once, the logGroup has been already created with the same name so your deployment will start failing. diff --git a/packages/aws-cdk-lib/cx-api/lib/features.ts b/packages/aws-cdk-lib/cx-api/lib/features.ts index 28e46f20f9540..f61559f4fc09e 100644 --- a/packages/aws-cdk-lib/cx-api/lib/features.ts +++ b/packages/aws-cdk-lib/cx-api/lib/features.ts @@ -660,7 +660,7 @@ export const FLAGS: Record = { ////////////////////////////////////////////////////////////////////// [IAM_IMPORTED_ROLE_STACK_SAFE_DEFAULT_POLICY_NAME]: { type: FlagType.BugFix, - summary: 'Enable this feature to by default create default policy names for imported roles that depend on the stack the role is in.', + summary: 'Enable this feature to create default policy names for imported roles that depend on the stack the role is in.', detailsMd: ` Without this, importing the same role in multiple places could lead to the permissions given for one version of the imported role 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 = { type: FlagType.BugFix, summary: 'Use S3 Bucket Policy instead of ACLs for Server Access Logging', detailsMd: ` - Enable this feature flag to use S3 Bucket Policy for granting permission fo Server Access Logging + Enable this feature flag to use S3 Bucket Policy for granting permission for Server Access Logging rather than using the canned \`LogDeliveryWrite\` ACL. ACLs do not work when Object Ownership is enabled on the bucket. @@ -976,7 +976,7 @@ export const FLAGS: Record = { summary: 'Enables aws-lambda-nodejs.Function to use the latest available NodeJs runtime as the default', detailsMd: ` If this is set, and a \`runtime\` prop is not passed to, Lambda NodeJs - functions will us the latest version of the runtime provided by the Lambda + functions will use the latest version of the runtime provided by the Lambda service. Do not use this if you your lambda function is reliant on dependencies shipped as part of the runtime environment. `, @@ -1162,7 +1162,7 @@ export const FLAGS: Record = { type: FlagType.ApiDefault, summary: 'When enabled, remove default deployment alarm settings', detailsMd: ` - When this featuer flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service. + When this feature flag is enabled, remove the default deployment alarm settings when creating a AWS ECS service. `, introducedIn: { v2: '2.143.0' }, recommendedValue: true, @@ -1415,8 +1415,8 @@ export const FLAGS: Record = { type: FlagType.VisibleContext, summary: 'When enabled, a stabilization loop will be run when invoking Aspects during synthesis.', detailsMd: ` - Currently, when Aspects are invoked in one single pass of the construct tree. - 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. + Previously, Aspects were invoked in a single pass of the construct tree. + 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. When this feature flag is enabled, a stabilization loop is run to recurse the construct tree multiple times when invoking Aspects. `, @@ -1606,7 +1606,7 @@ export const FLAGS: Record = { type: FlagType.ApiDefault, summary: 'When disabled, the value of the user pool client secret will not be logged in the custom resource lambda function logs.', detailsMd: ` - When this feature flag is enabled, the SDK API call response to desribe user pool client values will be logged in the custom + When this feature flag is enabled, the SDK API call response to describe user pool client values will be logged in the custom resource lambda function logs. 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 = { of the function (existing behavior). LogGroups created in this way do not support Tag propagation, Property Injectors, Aspects. - DO NOT ENABLE: If you have and existing app defining a lambda function and + DO NOT ENABLE: If you have an existing app defining a lambda function and have not supplied a logGroup or logRetention prop and your lambda function has executed at least once, the logGroup has been already created with the same name so your deployment will start failing.