AWS cdk documentation change
Summary
Fixed markdown syntax in service principal examples and clarified version-specific behavior
Security assessment
Changes correct code formatting (replacing incorrect backticks) and maintain documentation about a historical IAM service principal standardization fix. While service principals relate to security, these changes only improve documentation accuracy without introducing new security guidance or addressing active vulnerabilities.
Diff
diff --git a/cdk/v2/guide/deploy-troubleshoot.md b/cdk/v2/guide/deploy-troubleshoot.md index 059433937..348c0e185 100644 --- a//cdk/v2/guide/deploy-troubleshoot.md +++ b//cdk/v2/guide/deploy-troubleshoot.md @@ -40 +40 @@ The following is a basic example of creating an IAM role that can be assumed by -When you deploy this stack, a service principal named `logs.amazonaws.com` should be created. In most cases, AWS services use the following naming for service principals: ``service`.amazonaws.com`. +When you deploy this stack, a service principal named `logs.amazonaws.com` should be created. In most cases, AWS services use the following naming for service principals: `<service>.amazonaws.com`. @@ -46 +46 @@ If you are using a version of the AWS CDK older than v2.150.0, you may encounter -In AWS CDK v2.51.0, a fix was implemented by standardizing all automatically created service principals to use ``service`.amazonaws.com` when possible. This fix was available by allowing the `@aws-cdk/aws-iam:standardizedServicePrincipals` feature flag. +In AWS CDK v2.51.0, a fix was implemented by standardizing all automatically created service principals to use `<service>.amazonaws.com` when possible. This fix was available by allowing the `@aws-cdk/aws-iam:standardizedServicePrincipals` feature flag.