Package: aws-solutions-constructs.aws-lambda-ssmstringparameter
aws-lambda-ssmstringparameter module---All classes are under active development and subject to non-backward compatible changes or removal in any
future version. These are not subject to theSemantic Versioningmodel.
This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/LanguagePackagePythonaws_solutions_constructs.aws_lambda_ssm_string_parameterTypescript@aws-solutions-constructs/aws-lambda-ssmstringparameterJavasoftware.amazon.awsconstructs.services.lambdassmstringparameterOverviewThis AWS Solutions Construct implements the AWS Lambda function and AWS Systems Manager Parameter Store String parameter with the least privileged permissions.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{LambdaToSsmstringparameterProps,LambdaToSsmstringparameter}from'@aws-solutions-constructs/aws-lambda-ssmstringparameter';import*aslambdafrom'aws-cdk-lib/aws-lambda';constconstructProps:LambdaToSsmstringparameterProps={lambdaFunctionProps:{runtime:lambda.Runtime.NODEJS_16_X,code:lambda.Code.fromAsset(`lambda`),handler:'index.handler'},stringParameterProps:{stringValue:"test-string-value"}};newLambdaToSsmstringparameter(this,'test-lambda-ssmstringparameter-stack',constructProps);Pythonfromaws_solutions_constructs.aws_lambda_ssmstringparameterimportLambdaToSsmstringparameterfromaws_cdkimport(aws_lambdaas_lambda,aws_ssmasssm,Stack)fromconstructsimportConstructLambdaToSsmstringparameter(self,'test-lambda-ssmstringparameter-stack',lambda_function_props=_lambda.FunctionProps(code=_lambda.Code.from_asset('lambda'),runtime=_lambda.Runtime.PYTHON_3_9,handler='index.handler'),string_parameter_props=ssm.StringParameterProps(string_value="test-string-value"))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.lambda.*;importsoftware.amazon.awscdk.services.lambda.Runtime;importsoftware.amazon.awscdk.services.ssm.*;importsoftware.amazon.awsconstructs.services.lambdassmstringparameter.*;newLambdaToSsmstringparameter(this,"test-lambda-ssmstringparameter-stack",newLambdaToSsmstringparameterProps.Builder().lambdaFunctionProps(newFunctionProps.Builder().runtime(Runtime.NODEJS_16_X).code(Code.fromAsset("lambda")).handler("index.handler").build()).stringParameterProps(newStringParameterProps.Builder().stringValue("test-string-value").build()).build());Pattern Construct PropsNameTypeDescriptionexistingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this andlambdaFunctionPropswill cause an error.lambdaFunctionProps?lambda.FunctionPropsUser provided props to override the default props for the Lambda function.existingStringParameterObj?ssm.StringParameterExisting instance of SSM String parameter object, providing both this andstringParameterPropswill cause an errorstringParameterProps?ssm.StringParameterPropsOptional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supportedssm.StringParameterProps.typeisSTRINGif a different value is provided it will be overridden.stringParameterEnvironmentVariableName?stringOptional Name for the Lambda function environment variable set to the name of the parameter. Default: SSM_STRING_PARAMETER_NAMEexistingVpc?ec2.IVpcAn 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 Systems Manager Parameter. If an existing VPC is provided, thedeployVpcproperty cannot betrue. This usesec2.IVpcto allow clients to supply VPCs that exist outside the stack using theec2.Vpc.fromLookup()method.vpcProps?ec2.VpcPropsOptional user-provided properties to override the default properties for the new VPC.enableDnsHostnames,enableDnsSupport,natGatewaysandsubnetConfigurationare set by the pattern, so any values for those properties supplied here will be overridden. IfdeployVpcis nottruethen this property will be ignored.deployVpc?booleanWhether to create a new VPC based onvpcPropsinto which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:One isolated subnet in each Availability Zone used by the CDK programenableDnsHostnamesandenableDnsSupportwill both be set to trueIf this property istruethenexistingVpccannot be specified. Defaults tofalse.stringParameterPermissionsstringOptional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".Pattern PropertiesNameTypeDescriptionlambdaFunctionlambda.FunctionReturns an instance of lambda.Function created by the constructstringParameterssm.StringParameterReturns an instance of ssm.StringParameter created by the constructvpc?ec2.IVpcReturns an interface on the VPC used by the pattern (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.Default settingsOut of the box implementation of the Construct without any override will set the following defaults:AWS Lambda FunctionConfigure limited privilege access IAM role for Lambda functionEnable reusing connections with Keep-Alive for NodeJs Lambda functionEnable X-Ray TracingSet Environment Variables(default) SSM_STRING_PARAMETER_NAMEAWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)Amazon AWS Systems Manager Parameter Store StringEnable read-only access for the associated AWS Lambda FunctionCreates a new SSM String parameter with the values providedRetain the SSM String parameter when deleting the CloudFormation stackArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.