Skip to content

API.md

Latest commit

 

History

History
137 lines (77 loc) · 5.33 KB

API.md

File metadata and controls

137 lines (77 loc) · 5.33 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(includeExtras?: boolean, version?: string)
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.
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.

versionOptional 
public readonly version: string;
  • Type: string

The powertools package version from pypi repository.