aws-lambda-ssmstringparameter

Todas las clases están en desarrollo activo y están sujetas a cambios o eliminación no compatibles con versiones anteriores en cualquier versión futura. Estos no están sujetos a laVersiones semánticasModelo. Esto significa que, aunque puede usarlos, es posible que necesite actualizar el código fuente cuando actualice a una versión más reciente de este paquete.

Nota: Para garantizar una funcionalidad adecuada, los paquetes de AWS Solutions Constructs y los paquetes CDK de AWS del proyecto deben tener la misma versión.

Idioma	Paquete
Python	aws_solutions_constructs.aws_lambda_ssm_string_parameter
Mecanografía	@aws-solutions-constructs/aws-lambda-ssmstringparameter
Java	software.amazon.awsconstructs.services.lambdassmstringparameter

Overview

Este constructo de soluciones de AWS implementa la función AWS Lambda y el parámetro AWS Systems Manager Parameter Store String con los permisos menos privilegiados.

Aquí hay una definición mínima de patrón implementable en 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);

Parámetros

• scopeConstruct

• idstring

• propsLambdaToSsmstringparameterProps

Patrón de construcción

Nombre	Tipo	Descripción
¿ExistenteLambdaobj?	lambda.Function	Instancia existente del objeto Lambda Function, proporcionando tanto esto comolambdaFunctionPropsprovocará un error.
¿LambdaFunctionProps?	lambda.FunctionProps	Propiedades opcionales proporcionadas por el usuario para anular las propiedades predeterminadas de la función Lambda. Se pasa por alto si seexistingLambdaObjse encuentra.
ExistingStringParameterObj?	ssm.StringParameter	Instancia existente del objeto de parámetro SSM String, proporcionando tanto esto comostringParameterPropsprovocará un error.
StringParameterProps?	ssm.StringParameterProps	El usuario ha proporcionado accesorios opcionales para anular los apoyos predeterminados para el parámetro SSM String. SiexistingStringParameterObjno está establecido,stringParameterPropses obligatorio. El único soportessm.StringParameterProps.typeesSTRINGsi se proporciona un valor diferente, se anulará.
StringParameterEnvironmentVariableName?	string	Nombre opcional para el conjunto de variables de entorno del parámetro SSM String para la función Lambda.
¿Existe VPC?	ec2.IVpc	Una VPC opcional existente en la que se debe implementar este patrón. Cuando se implementa en una VPC, la función Lambda utilizará ENI en la VPC para acceder a los recursos de red y se creará un extremo de interfaz en el parámetro VPC for AWS Systems Manager. Si se proporciona una VPC existente, eldeployVpcno se puedetrue. Usaec2.IVpcpara permitir que los clientes suministren VPC que existen fuera de la pila mediante el comandoec2.Vpc.fromLookup()Método de.
¿VPCProps?	ec2.VpcProps	Propiedades opcionales proporcionadas por el usuario para anular las propiedades predeterminadas de la nueva VPC.enableDnsHostnames,enableDnsSupport,natGatewaysysubnetConfigurationestán establecidos por el patrón, por lo que cualquier valor para esas propiedades suministradas aquí será anulado. SideployVpcno estrueentonces esta propiedad será ignorada.
¿Implementar VPC?	boolean	Si se crea una VPC nueva basada envpcPropsen el que desplegar este patrón. Configuración de esto entrueimplementará la VPC mínima y más privada para ejecutar el patrón: Una subred aislada en cada zona de disponibilidad utilizada por el programa CDK. enableDnsHostnamesyenableDnsSupportambos se establecerán entrue. Si esta propiedad está establecida entrue, luegoexistingVpcNo se puede especificar . El valor predeterminado es false.
StringParameterPermissions?	string	Permisos opcionales del parámetro SSM String para conceder a la función Lambda. Puede especificarse una de las siguientes opciones:Read,ReadWrite.

Propiedades de patrón

Nombre	Tipo	Descripción
Lambdafunction	lambda.Function	Devuelve una instancia delambda.Functioncreado por el componente fijo.
StringParameter	ssm.StringParameter	Devuelve una instancia dessm.StringParametercreado por el componente fijo.
¿VPC?	ec2.IVpc	Devuelve una interfaz en la VPC utilizada por el patrón (si la hay). Esta puede ser una VPC creada por el patrón o la VPC suministrada al constructor del patrón.

Configuración predeterminada

La implementación lista para usar de este patrón sin anulación establecerá los siguientes valores predeterminados:

Función de AWS Lambda

• Configurar el rol de IAM de acceso limitado con privilegios para la función Lambda.

• Habilite la reutilización de conexiones con la función Keep-Alive para NodeJS Lambda.

• Active el rastreo de X-Ray.

• Configuración de las variables de entorno:

  • SSM_STRING_PARAMETER_NAME (predeterminado)

  • AWS_NODEJS_CONNECTION_REUSE_ENABLED(para Node 10.x y funciones superiores)

String de almacén de parámetros de Amazon Systems Manager

• Habilite el acceso de sólo lectura para la función AWS Lambda asociada.

• Crea un nuevo parámetro de cadena SSM con los valores proporcionados.

• Conservar el parámetro SSM String al eliminar la pila CloudFormation.

Architecture

GitHub

Para ver el código de este patrón, crear/ver problemas y solicitudes de extracción, y mucho más:
	@aws -soluciones-constructs/aws-lambda-ssmstringparameter