Skip to content
This repository was archived by the owner on Sep 8, 2022. It is now read-only.

Latest commit

 

History

History
156 lines (88 loc) · 6.26 KB

API.md

File metadata and controls

156 lines (88 loc) · 6.26 KB

API Reference

Constructs

LambdaPowertoolsLayer

Defines a new Lambda Layer with Powertools for python library.

Initializers 

import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer'

new LambdaPowertoolsLayer(scope: Construct, id: string, props?: PowertoolsLayerProps)
Name Type Description
scope* constructs.Construct No description.
id* string No description.
props cdk-lambda-powertools-python-layer.PowertoolsLayerProps No description.
scopeRequired
idRequired
  • Type: string
propsOptional

Static Functions

Name Description
constructBuildArgs creates build argument for the Dockerfile.
constructBuildArgs 
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer'

LambdaPowertoolsLayer.constructBuildArgs(runtimeFamily: RuntimeFamily, includeExtras?: boolean, version?: string)
runtimeFamilyRequired
includeExtrasOptional
  • Type: boolean
versionOptional
  • Type: string

Structs

PowertoolsLayerProps

Properties for Powertools layer for python.

Initializer 

import { PowertoolsLayerProps } from 'cdk-lambda-powertools-python-layer'

const powertoolsLayerProps: PowertoolsLayerProps = { ... }

Properties

Name Type Description
includeExtras boolean A flag for the pydantic extras dependency, used for parsing.
layerVersionName string the name of the layer, will be randomised if empty.
runtimeFamily aws-cdk-lib.aws_lambda.RuntimeFamily the runtime of the layer.
version string The powertools package version from pypi repository.
includeExtrasOptional 
public readonly includeExtras: boolean;
  • Type: boolean

A flag for the pydantic extras dependency, used for parsing.

This will increase the size of the layer significantly. If you don't use parsing, ignore it.

layerVersionNameOptional 
public readonly layerVersionName: string;
  • Type: string

the name of the layer, will be randomised if empty.

runtimeFamilyOptional 
public readonly runtimeFamily: RuntimeFamily;

the runtime of the layer.

versionOptional 
public readonly version: string;
  • Type: string

The powertools package version from pypi repository.