From ea6a6415e82902322ec0c4cd2037fe1eb1cd4bef Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 13 Jan 2022 00:14:58 +0000 Subject: [PATCH 1/2] chore(deps): upgrade dependencies Upgrades project dependencies. See details in [workflow run]. [Workflow Run]: https://github.com/aws-samples/cdk-lambda-powertools-python-layer/actions/runs/1690348693 ------ *Automatically created by projen via the "upgrade-main" workflow* Signed-off-by: github-actions --- package.json | 2 +- yarn.lock | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index 5d6230c..972d7bc 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "jest-junit": "^13", "jsii": "^1.52.1", "jsii-diff": "^1.52.1", - "jsii-docgen": "^4.2.37", + "jsii-docgen": "^4.2.38", "json-schema": "^0.4.0", "npm-check-updates": "^12", "projen": "^0.50.21", diff --git a/yarn.lock b/yarn.lock index c806f81..889ac58 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1961,9 +1961,9 @@ duplexer3@^0.1.4: integrity sha1-7gHdHKwO08vH/b6jfcCo8c4ALOI= electron-to-chromium@^1.4.17: - version "1.4.43" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.43.tgz#665c0cd8d5e7cce0ba78d90a514c8c813ca3bdbe" - integrity sha512-PO3kEfcxPrti/4STbXvCkNIF4fgWvCKl2508e6UI7KomCDffpIfeBZLXsh5DK/XGsjUw3kwq6WEsi0MJTlGAdg== + version "1.4.44" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.44.tgz#8a41923afdd6ef5ddabe001626036ba5d1d64ae6" + integrity sha512-tHGWiUUmY7GABK8+DNcr474cnZDTzD8x1736SlDosVH8+/vRJeqfaIBAEHFtMjddz/0T4rKKYsxEc8BwQRdBpw== emittery@^0.8.1: version "0.8.1" @@ -3705,10 +3705,10 @@ jsii-diff@^1.52.1: typescript "~3.9.10" yargs "^16.2.0" -jsii-docgen@^4.2.37: - version "4.2.37" - resolved "https://registry.yarnpkg.com/jsii-docgen/-/jsii-docgen-4.2.37.tgz#b22246a57163bc3d28d5c1d49302e53f4347cd32" - integrity sha512-67kfUe1ayJ9rMuPx124Mhi5vgShwbayGAnIF3ayXLb97KL09RhmhqSJr6ux5I1OthNnZ02QqWqvQx6hEDdX0Cw== +jsii-docgen@^4.2.38: + version "4.2.38" + resolved "https://registry.yarnpkg.com/jsii-docgen/-/jsii-docgen-4.2.38.tgz#60a413c7b3a02722d61689b9a6b719adb6162619" + integrity sha512-LrYtn4mShUZFDWwWNZbAv6Zt9PeSNJlg0qQZZ9FlwPv5IilLf9El01ahOOiybXYGY3Z465t1B8XYui4J6N92sw== dependencies: "@jsii/spec" "^1.52.1" case "^1.6.3" From b2d8793e46aa0d4d9773e6719cabf6e68cbc00b1 Mon Sep 17 00:00:00 2001 From: Alexander Melnyk Date: Thu, 13 Jan 2022 08:54:17 +0100 Subject: [PATCH 2/2] docs: add API.md --- API.md | 124 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..f73187e --- /dev/null +++ b/API.md @@ -0,0 +1,124 @@ +# API Reference + +## Constructs + +### LambdaPowertoolsLayer + +Defines a new Lambda Layer with Powertools for python library. + +#### Initializers + +```typescript +import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer' + +new LambdaPowertoolsLayer(scope: Construct, id: string, props?: PowertoolsLayerProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| [`scope`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* | +| [`id`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterid)* | `string` | *No description.* | +| [`props`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterprops) | [`cdk-lambda-powertools-python-layer.PowertoolsLayerProps`](#cdk-lambda-powertools-python-layer.PowertoolsLayerProps) | *No description.* | + +--- + +##### `scope`Required + +- *Type:* [`constructs.Construct`](#constructs.Construct) + +--- + +##### `id`Required + +- *Type:* `string` + +--- + +##### `props`Optional + +- *Type:* [`cdk-lambda-powertools-python-layer.PowertoolsLayerProps`](#cdk-lambda-powertools-python-layer.PowertoolsLayerProps) + +--- + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| [`constructBuildArgs`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerconstructbuildargs) | creates build argument for the Dockerfile. | + +--- + +##### `constructBuildArgs` + +```typescript +import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer' + +LambdaPowertoolsLayer.constructBuildArgs(includeExtras?: boolean, version?: string) +``` + +###### `includeExtras`Optional + +- *Type:* `boolean` + +--- + +###### `version`Optional + +- *Type:* `string` + +--- + + + +## Structs + +### PowertoolsLayerProps + +Properties for Powertools layer for python. + +#### Initializer + +```typescript +import { PowertoolsLayerProps } from 'cdk-lambda-powertools-python-layer' + +const powertoolsLayerProps: PowertoolsLayerProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| [`includeExtras`](#cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyincludeextras) | `boolean` | A flag for the pydantic extras dependency, used for parsing. | +| [`version`](#cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyversion) | `string` | The powertools package version from pypi repository. | + +--- + +##### `includeExtras`Optional + +```typescript +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. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* `string` + +The powertools package version from pypi repository. + +--- + + +