awssolutionsconstructsawslambdassmstringparameter

README

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 the Semantic Versioning model. 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/

Language	Package
Python	aws_solutions_constructs.aws_lambda_ssm_string_parameter
Typescript	@aws-solutions-constructs/aws-lambda-ssmstringparameter
Java	software.amazon.awsconstructs.services.lambdassmstringparameter

This 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 in 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);

Parameters

• scope Construct
• id string
• props LambdaToSsmstringparameterProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	User provided props to override the default props for the Lambda function.
existingStringParameterObj?	ssm.StringParameter	Existing instance of SSM String parameter object, providing both this and stringParameterProps will cause an error
stringParameterProps?	ssm.StringParameterProps	Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported ssm.StringParameterProps.type is STRING if a different value is provided it will be overridden.
stringParameterEnvironmentVariableName?	string	Optional Name for the SSM String parameter environment variable set for the Lambda function.
existingVpc?	ec2.IVpc	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 Systems Manager Parameter. 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() method.
vpcProps?	ec2.VpcProps	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.
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: One isolated subnet in each Availability Zone used by the CDK program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.
stringParameterPermissions	string	Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".

Pattern Properties

Name	Type	Description
lambdaFunction	lambda.Function	Returns an instance of lambda.Function created by the construct
stringParameter	ssm.StringParameter	Returns an instance of ssm.StringParameter created by the construct
vpc?	ec2.IVpc	Returns 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 settings

Out of the box implementation of the Construct without any override will set the following defaults:

AWS Lambda Function

• Configure limited privilege access IAM role for Lambda function
• Enable reusing connections with Keep-Alive for NodeJs Lambda function
• Enable X-Ray Tracing
• Set Environment Variables
  • (default) SSM_STRING_PARAMETER_NAME
  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)

Amazon AWS Systems Manager Parameter Store String

• Enable read-only access for the associated AWS Lambda Function
• Creates a new SSM String parameter with the values provided
• Retain the SSM String parameter when deleting the CloudFormation stack

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter

Index

• func LambdaToSsmstringparameter_IsConstruct(x interface{}) *bool
• func NewLambdaToSsmstringparameter_Override(l LambdaToSsmstringparameter, scope constructs.Construct, id *string, ...)
• type LambdaToSsmstringparameter
  • func NewLambdaToSsmstringparameter(scope constructs.Construct, id *string, props *LambdaToSsmstringparameterProps) LambdaToSsmstringparameter
• type LambdaToSsmstringparameterProps

Functions

func LambdaToSsmstringparameter_IsConstruct

func LambdaToSsmstringparameter_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToSsmstringparameter_Override

func NewLambdaToSsmstringparameter_Override(l LambdaToSsmstringparameter, scope constructs.Construct, id *string, props *LambdaToSsmstringparameterProps)

Types

type LambdaToSsmstringparameter

type LambdaToSsmstringparameter interface {
	constructs.Construct
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	StringParameter() awsssm.StringParameter
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToSsmstringparameter

func NewLambdaToSsmstringparameter(scope constructs.Construct, id *string, props *LambdaToSsmstringparameterProps) LambdaToSsmstringparameter

type LambdaToSsmstringparameterProps

type LambdaToSsmstringparameterProps struct {
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// Existing instance of Lambda Function object, if this is set then the lambdaFunctionProps is ignored.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// Existing instance of SSM String parameter object, If this is set then the stringParameterProps is ignored.
	ExistingStringParameterObj awsssm.StringParameter `json:"existingStringParameterObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// Optional Name for the SSM String parameter environment variable set for the Lambda function.
	StringParameterEnvironmentVariableName *string `json:"stringParameterEnvironmentVariableName"`
	// Optional SSM String parameter permissions to grant to the Lambda function.
	//
	// One of the following may be specified: "Read", "ReadWrite".
	StringParameterPermissions *string `json:"stringParameterPermissions"`
	// Optional user provided props to override the default props for SSM String parameter.
	//
	// If existingStringParameterObj
	// is not set stringParameterProps is required. The only supported string parameter type is ParameterType.STRING.
	StringParameterProps *awsssm.StringParameterProps `json:"stringParameterProps"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}