Skip to content

Commit 1b843bf

Browse files
authored
fix(aws-lambda-secretsmanager): Update docs (#673)
* Update README.md * Update index.ts
1 parent bcb7c63 commit 1b843bf

File tree

2 files changed

+4
-4
lines changed
  • source/patterns/@aws-solutions-constructs/aws-lambda-secretsmanager

2 files changed

+4
-4
lines changed

source/patterns/@aws-solutions-constructs/aws-lambda-secretsmanager/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ new LambdaToSecretsmanager(this, "test-lambda-secretsmanager-stack", new LambdaT
9090
|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
9191
|secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
9292
|existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
93-
|grantWriteAccess?|`boolean`|Optional write access to the Secret for the Lambda function (Read-Only by default)
94-
|secretEnvironmentVariableName?|`string`|Optional Name for the Secrets Manager secret environment variable set for the Lambda function.|
93+
|grantWriteAccess?|`string`|Optional Access granted to the Lambda function for the secret. 'Read' or 'ReadWrite". Default is "Read"
94+
|secretEnvironmentVariableName?|`string`|Optional Name for Lambda function environment variable containing the ARN of the secret. Default is SECRET_ARN. |
9595
|existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for AWS Secrets Manager. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.|
9696
|vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.VpcProps.html)|Optional user-provided properties to override the default properties for the new VPC. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overrriden. If `deployVpc` is not `true` then this property will be ignored.|
9797
|deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|

source/patterns/@aws-solutions-constructs/aws-lambda-secretsmanager/lib/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ export interface LambdaToSecretsmanagerProps {
6161
*/
6262
readonly deployVpc?: boolean;
6363
/**
64-
* Optional Name for the Secret environment variable set for the Lambda function.
64+
* Optional Name for Lambda function environment variable containing the ARN of the secret.
6565
*
66-
* @default - SECRET_NAME
66+
* @default - SECRET_ARN
6767
*/
6868
readonly secretEnvironmentVariableName?: string;
6969
/**

0 commit comments

Comments
 (0)