本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
aws-lambda-管理字符串参数
所有类都处于积极开发之中,并且在任何未来版本中都会受到非向后兼容的更改或删除。这些不受语义版本控制
注意: 为确保正确的功能,您项目中的 AWS 解决方案构造软件包和 AWS CDK 包必须是相同的版本。
| 语言 | 程序包 |
|---|---|
|
aws_solutions_constructs.aws_lambda_ssm_string_parameter
|
|
@aws-solutions-constructs/aws-lambda-ssmstringparameter
|
|
software.amazon.awsconstructs.services.lambdassmstringparameter
|
Overview
此 AWS 解决方案构造使用最低权限实现 AWS Lambda 函数和 AWS Systems Manager Parameter Store 字符串参数。
以下是 TypeScript 中的最小可部署模式定义:
const { LambdaToSsmstringparameterProps, LambdaToSsmstringparameter } from '@aws-solutions-constructs/aws-lambda-ssmstringparameter'; const props: LambdaToSsmstringparameterProps = { lambdaFunctionProps: { runtime: lambda.Runtime.NODEJS_14_X, // This assumes a handler function in lib/lambda/index.js code: lambda.Code.fromAsset(`${__dirname}/lambda`), handler: 'index.handler' }, stringParameterProps: { stringValue: "test-string-value" } }; new LambdaToSsmstringparameter(this, 'test-lambda-ssmstringparameter-stack', props);
Initializer
new LambdaToSsmstringparameter(scope: Construct, id: string, props: LambdaToSsmstringparameterProps);
参数
-
scope
Construct -
id
string
模式构建道具
| 名称 | 类型 | 描述 |
|---|---|---|
| 现在的兰姆道夫? |
lambda.Function
|
Lambda 函数对象的现有实例,提供了这个和lambdaFunctionProps会导致错误。 |
| Lambda 功能道具? |
lambda.FunctionProps
|
用户提供的可选属性,用于覆盖 Lambda 函数的默认属性。忽略existingLambdaObj提供。 |
| 现有的字符串参数 ROBJ? |
ssm.StringParameter
|
SSM String 参数对象的现有实例,同时提供此和stringParameterProps会导致错误。 |
| 字符串参数道具? |
ssm.StringParameterProps
|
可选的用户提供的道具来覆盖 SSM 字符串参数的默认道具。如果existingStringParameterObj未设置,stringParameterProps是必需的。唯一受支持ssm.StringParameterProps.type是STRING如果提供了不同的值,它将被覆盖。 |
| 字符串参数变量名称? |
string
|
为 Lambda 函数设置的 SSM 字符串参数环境变量的可选名称。 |
| 是否存在 VPC? |
ec2.IVpc
|
应在其中部署此模式的可选现有 VPC。在 VPC 中部署时,Lambda 函数将使用 VPC 中的 ENI 访问网络资源,并将在适用于 AWS Systems Manager 参数的 VPC 中创建接口终端节点。如果提供了现有 VPC,则deployVpc属性不能是true。这使用ec2.IVpc,以允许客户端使用ec2.Vpc.fromLookup()方法。 |
| VPCPROP? |
ec2.VpcProps
|
用户提供的可选属性,用于覆盖新 VPC 的默认属性。enableDnsHostnames、enableDnsSupport、natGateways和subnetConfiguration是由模式设置的,所以这里提供的这些属性的任何值都将被覆盖。如果deployVpc不是true那么这个属性将被忽略。 |
| 部署 VPC? |
boolean
|
是否创建新 VPCvpcProps将此模式部署到其中。将此设置为true将部署最小的、最私有的 VPC 来运行模式:
true,然后existingVpc则无法指定 。默认值为 false。 |
| 字符串参数权限? |
string
|
授予 Lambda 函数的可选 SSM 字符串参数权限。可指定以下内容之一:Read、ReadWrite。 |
模式属性
| 名称 | 类型 | 描述 |
|---|---|---|
| LambdaFunction |
lambda.Function
|
返回lambda.Function由构造创建。 |
| StringParameter |
ssm.StringParameter
|
返回ssm.StringParameter由构造创建。 |
| VPC? |
ec2.IVpc
|
返回模式使用的 VPC 上的接口(如果有)。这可能是由模式创建的 VPC,也可以是提供给模式构造函数的 VPC。 |
默认设置
没有任何覆盖的此模式的开箱即用实现将设置以下默认值:
AWS Lambda 函数
-
为 Lambda 函数配置有限权限访问 IAM 角色。
-
使用节点 JS Lambda 函数保持活动状态,启用重复使用连接。
-
启用 X-Ray 跟踪。
-
设置环境变量:
-
SSM_STRING_PARAMETER_NAME(默认值) -
AWS_NODEJS_CONNECTION_REUSE_ENABLED(用于节点 10.x 和更高版本的功能)
-
Amazon AWS Systems Manager Parameter Store 字符串
-
启用关联的 AWS Lambda 函数的只读访问权限。
-
使用提供的值创建一个新的 SSM 字符串参数。
-
删除 CloudFormation 堆栈时,保留 SSM 字符串参数。
Architecture
GitHub
| 要查看此模式的代码、创建/查看问题和拉取请求等,请执行以下操作: | |
|---|---|
|
@aws-解决方案结构/aws-lambda-管理字符串参数 |