AWS cdk documentation change
Summary
Removed redundant 'Topics' section, added backticks around method/command references, and minor typo/formatting fixes. Maintained existing warnings about secure string handling.
Security assessment
Changes focus on documentation structure and clarity. The existing security warning about sensitive values in CloudFormation templates remains unaltered except for punctuation. No new security guidance or vulnerability fixes were added.
Diff
diff --git a/cdk/v2/guide/get-ssm-value.md b/cdk/v2/guide/get-ssm-value.md index 008dd9028..9b0316d3f 100644 --- a//cdk/v2/guide/get-ssm-value.md +++ b//cdk/v2/guide/get-ssm-value.md @@ -19,11 +18,0 @@ This topic shows how to read attributes from the AWS Systems Manager Parameter S -###### Topics - - * Read Systems Manager values at deployment time - - * Read Systems Manager values at synthesis time - - * Write values to Systems Manager - - - - @@ -32 +21 @@ This topic shows how to read attributes from the AWS Systems Manager Parameter S -To read values from the Systems Manager Parameter Store, use the [valueForStringParameter](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrforwbrstringwbrparameterscope-parametername-version) and [valueForSecureStringParameter](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrforwbrsecurewbrstringwbrparameterscope-parametername-version) methods. Choose a method based on whether the attribute you want is a plain string or a secure string value. These methods return [tokens](./tokens.html), not the actual value. The value is resolved by AWS CloudFormation during deployment. The following is an example: +To read values from the Systems Manager Parameter Store, use the [`valueForStringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrforwbrstringwbrparameterscope-parametername-version) and [`valueForSecureStringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrforwbrsecurewbrstringwbrparameterscope-parametername-version) methods. Choose a method based on whether the attribute you want is a plain string or a secure string value. These methods return [tokens](./tokens.html), not the actual value. The value is resolved by AWS CloudFormation during deployment. The following is an example: @@ -118 +107 @@ A [limited number of AWS services](https://docs.aws.amazon.com/AWSCloudFormation -At times, it's useful to provide a parameter at synthesis time. By doing this, the AWS CloudFormation template will always use the same value instead of resolving the value during deployment. +At times, it’s useful to provide a parameter at synthesis time. By doing this, the AWS CloudFormation template will always use the same value instead of resolving the value during deployment. @@ -120 +109 @@ At times, it's useful to provide a parameter at synthesis time. By doing this, t -To read a value from the Systems Manager Parameter Store at synthesis time, use the [valueFromLookup](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrfromwbrlookupscope-parametername) method (Python: `value_from_lookup`). This method returns the actual value of the parameter as a [Context values and the AWS CDK](./context.html) value. If the value is not already cached in `cdk.json` or passed on the command line, it is retrieved from the current AWS account. For this reason, the stack _must_ be synthesized with explicit AWS environment information. +To read a value from the Systems Manager Parameter Store at synthesis time, use the [`valueFromLookup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html#static-valuewbrfromwbrlookupscope-parametername) method (Python: `value_from_lookup`). This method returns the actual value of the parameter as a [Context values and the AWS CDK](./context.html) value. If the value is not already cached in `cdk.json` or passed on the command line, it is retrieved from the current AWS account. For this reason, the stack _must_ be synthesized with explicit AWS environment information. @@ -168 +157 @@ Only plain Systems Manager strings may be retrieved. Secure strings cannot be re -The retrieved value will end up in your synthesized AWS CloudFormation template. This might be a security risk, depending on who has access to your AWS CloudFormation templates and what kind of value it is. Generally, don't use this feature for passwords, keys, or other values you want to keep private. +The retrieved value will end up in your synthesized AWS CloudFormation template. This might be a security risk, depending on who has access to your AWS CloudFormation templates and what kind of value it is. Generally, don’t use this feature for passwords, keys, or other values you want to keep private. @@ -172 +161 @@ The retrieved value will end up in your synthesized AWS CloudFormation template. -You can use the AWS CLI, the AWS Management Console, or an AWS SDK to set Systems Manager parameter values. The following examples use the [ssm put-parameter](https://docs.aws.amazon.com/cli/latest/reference/ssm/put-parameter.html) CLI command. +You can use the AWS CLI, the AWS Management Console, or an AWS SDK to set Systems Manager parameter values. The following examples use the [`ssm put-parameter`](https://docs.aws.amazon.com/cli/latest/reference/ssm/put-parameter.html) CLI command.