AWS cdk documentation change
Summary
Removed 'Topics' section header and list, updated code formatting (placeholder syntax and apostrophes), fixed Python code syntax, and made minor text consistency changes
Security assessment
Changes are primarily formatting improvements (placeholder syntax with angle brackets), typographical fixes (curly apostrophes), and code example corrections. No security vulnerabilities, mitigations, or security feature documentation were added or modified. The profile usage clarification maintains existing security practices without introducing new security context.
Diff
diff --git a/cdk/v2/guide/configure-env.md b/cdk/v2/guide/configure-env.md index 2f3d27178..c89020895 100644 --- a//cdk/v2/guide/configure-env.md +++ b//cdk/v2/guide/configure-env.md @@ -17,17 +16,0 @@ For an introduction to AWS environments, see [Environments for the AWS CDK](./en -###### Topics - - * Where you can specify environments from - - * Environment precedence with the AWS CDK - - * When to specify environments - - * How to specify environments with the AWS CDK - - * Considerations when configuring environments with the AWS CDK - - * Examples - - - - @@ -79 +62 @@ If you use environment variables within the `env` property, you must use the `-- -Environment information within the CloudFormation template takes precedence over other methods. For example, if you provide a different environment with `cdk deploy --profile `profile``, the profile will be ignored. +Environment information within the CloudFormation template takes precedence over other methods. For example, if you provide a different environment with `cdk deploy --profile <profile>`, the profile will be ignored. @@ -85 +68 @@ When you provide environment information in this way, you can use environment-de -If you don't specify an environment using the `env` property of the `Stack` construct, the CDK CLI will produce an environment-agnostic CloudFormation template at synthesis. You can then specify the environment to deploy to by using `cdk deploy --profile `profile``. +If you don’t specify an environment using the `env` property of the `Stack` construct, the CDK CLI will produce an environment-agnostic CloudFormation template at synthesis. You can then specify the environment to deploy to by using `cdk deploy --profile <profile>`. @@ -87 +70 @@ If you don't specify an environment using the `env` property of the `Stack` cons -If you don't specify a profile when deploying an environment-agnostic template, the CDK CLI will attempt to use environment values from the `default` profile of your `credentials` and `config` files at deployment. +If you don’t specify a profile when deploying an environment-agnostic template, the CDK CLI will attempt to use environment values from the `default` profile of your `credentials` and `config` files at deployment. @@ -212 +195 @@ TypeScript -Access environment variables via Node's `process` object. +Access environment variables via Node’s `process` object. @@ -216 +199 @@ Access environment variables via Node's `process` object. -You need the `DefinitelyTyped` module to use `process` in TypeScript. `cdk init` installs this module for you. However, you should install this module manually if you are working with a project created before it was added, or if you didn't set up your project using `cdk init`. +You need the `DefinitelyTyped` module to use `process` in TypeScript. `cdk init` installs this module for you. However, you should install this module manually if you are working with a project created before it was added, or if you didn’t set up your project using `cdk init`. @@ -231 +214 @@ JavaScript -Access environment variables via Node's `process` object. +Access environment variables via Node’s `process` object. @@ -243 +226 @@ Python -Use the `os` module's `environ` dictionary to access environment variables. +Use the `os` module’s `environ` dictionary to access environment variables. @@ -317 +300 @@ By specifying environments using environment variables, you can have the same CD -This approach is great for development environments when deploying the same stack to different environments. However, we do not recommend this approach for production environments since the same CDK code can synthesize different templates, depending on the machine, user, or session that it's synthesized under. +This approach is great for development environments when deploying the same stack to different environments. However, we do not recommend this approach for production environments since the same CDK code can synthesize different templates, depending on the machine, user, or session that it’s synthesized under. @@ -324 +307 @@ When deploying an environment-agnostic template, use the `--profile` option with - $ cdk deploy myStack --profile prod + $ cdk deploy <myStack> --profile <prod> @@ -480 +463 @@ To deploy this stack to an environment that is specified in the `dev` profile of -If we don't specify a profile, the CDK CLI will attempt to use environment information from the `default` profile in our credentials and configuration files. +If we don’t specify a profile, the CDK CLI will attempt to use environment information from the `default` profile in our credentials and configuration files. @@ -512,0 +496,2 @@ Python + ) + )