AWS cdk documentation change
Summary
Formatting changes including code syntax fixes (closing braces in examples), backticks added around method/command references, and typo fixes. No substantive content changes regarding secret handling.
Security assessment
Changes are purely formatting and syntax corrections. The existing security guidance about using SecretValue tokens to avoid exposing secrets remains unchanged. No new security considerations were introduced.
Diff
diff --git a/cdk/v2/guide/get-secrets-manager-value.md b/cdk/v2/guide/get-secrets-manager-value.md index c3284c48f..a73f3af0a 100644 --- a//cdk/v2/guide/get-secrets-manager-value.md +++ b//cdk/v2/guide/get-secrets-manager-value.md @@ -9 +9 @@ This is the AWS CDK v2 Developer Guide. The older CDK v1 entered maintenance on -To use values from AWS Secrets Manager in your AWS CDK app, use the [fromSecretAttributes()](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#static-fromwbrsecretwbrattributesscope-id-attrs) method. It represents a value that is retrieved from Secrets Manager and used at AWS CloudFormation deployment time. The following is an example: +To use values from AWS Secrets Manager in your AWS CDK app, use the [`fromSecretAttributes()`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#static-fromwbrsecretwbrattributesscope-id-attrs) method. It represents a value that is retrieved from Secrets Manager and used at AWS CloudFormation deployment time. The following is an example: @@ -26 +26,4 @@ TypeScript - }); + } + ); + } + } @@ -103,0 +107 @@ C# + } @@ -107 +111 @@ C# -Use the AWS CLI [create-secret](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html) CLI command to create a secret from the command line, such as when testing: +Use the AWS CLI [`create-secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html) CLI command to create a secret from the command line, such as when testing: @@ -114 +118 @@ The command returns an ARN that you can use with the preceding example. -Once you have created a `Secret` instance, you can get the secret's value from the instance's `secretValue` attribute. The value is represented by a `[SecretValue](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html)` instance, a special type of [Tokens and the AWS CDK](./tokens.html). Because it's a token, it has meaning only after resolution. Your CDK app does not need to access its actual value. Instead, the app can pass the `SecretValue` instance (or its string or numeric representation) to whatever CDK method needs the value. +Once you have created a `Secret` instance, you can get the secret’s value from the instance’s `secretValue` attribute. The value is represented by a [`SecretValue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) instance, a special type of [Tokens and the AWS CDK](./tokens.html). Because it’s a token, it has meaning only after resolution. Your CDK app does not need to access its actual value. Instead, the app can pass the `SecretValue` instance (or its string or numeric representation) to whatever CDK method needs the value.