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

Commit efaa724

Browse files
Alexander Melnykgithub-actions
Alexander Melnyk
and
github-actions
authored
chore(deps): upgrade dependencies (#16)
* 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 <github-actions@github.com> * docs: add API.md Co-authored-by: github-actions <github-actions@github.com>
1 parent e804200 commit efaa724

File tree

3 files changed

+132
-8
lines changed

3 files changed

+132
-8
lines changed

API.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# API Reference <a name="API Reference" id="api-reference"></a>
2+
3+
## Constructs <a name="Constructs" id="constructs"></a>
4+
5+
### LambdaPowertoolsLayer <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer" id="cdklambdapowertoolspythonlayerlambdapowertoolslayer"></a>
6+
7+
Defines a new Lambda Layer with Powertools for python library.
8+
9+
#### Initializers <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.Initializer" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerinitializer"></a>
10+
11+
```typescript
12+
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer'
13+
14+
new LambdaPowertoolsLayer(scope: Construct, id: string, props?: PowertoolsLayerProps)
15+
```
16+
17+
| **Name** | **Type** | **Description** |
18+
| --- | --- | --- |
19+
| [`scope`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterscope)<span title="Required">*</span> | [`constructs.Construct`](#constructs.Construct) | *No description.* |
20+
| [`id`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterid)<span title="Required">*</span> | `string` | *No description.* |
21+
| [`props`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterprops) | [`cdk-lambda-powertools-python-layer.PowertoolsLayerProps`](#cdk-lambda-powertools-python-layer.PowertoolsLayerProps) | *No description.* |
22+
23+
---
24+
25+
##### `scope`<sup>Required</sup> <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.parameter.scope" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterscope"></a>
26+
27+
- *Type:* [`constructs.Construct`](#constructs.Construct)
28+
29+
---
30+
31+
##### `id`<sup>Required</sup> <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.parameter.id" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterid"></a>
32+
33+
- *Type:* `string`
34+
35+
---
36+
37+
##### `props`<sup>Optional</sup> <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.parameter.props" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterprops"></a>
38+
39+
- *Type:* [`cdk-lambda-powertools-python-layer.PowertoolsLayerProps`](#cdk-lambda-powertools-python-layer.PowertoolsLayerProps)
40+
41+
---
42+
43+
44+
#### Static Functions <a name="Static Functions" id="static-functions"></a>
45+
46+
| **Name** | **Description** |
47+
| --- | --- |
48+
| [`constructBuildArgs`](#cdklambdapowertoolspythonlayerlambdapowertoolslayerconstructbuildargs) | creates build argument for the Dockerfile. |
49+
50+
---
51+
52+
##### `constructBuildArgs` <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.constructBuildArgs" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerconstructbuildargs"></a>
53+
54+
```typescript
55+
import { LambdaPowertoolsLayer } from 'cdk-lambda-powertools-python-layer'
56+
57+
LambdaPowertoolsLayer.constructBuildArgs(includeExtras?: boolean, version?: string)
58+
```
59+
60+
###### `includeExtras`<sup>Optional</sup> <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.parameter.includeExtras" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterincludeextras"></a>
61+
62+
- *Type:* `boolean`
63+
64+
---
65+
66+
###### `version`<sup>Optional</sup> <a name="cdk-lambda-powertools-python-layer.LambdaPowertoolsLayer.parameter.version" id="cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterversion"></a>
67+
68+
- *Type:* `string`
69+
70+
---
71+
72+
73+
74+
## Structs <a name="Structs" id="structs"></a>
75+
76+
### PowertoolsLayerProps <a name="cdk-lambda-powertools-python-layer.PowertoolsLayerProps" id="cdklambdapowertoolspythonlayerpowertoolslayerprops"></a>
77+
78+
Properties for Powertools layer for python.
79+
80+
#### Initializer <a name="[object Object].Initializer" id="object-objectinitializer"></a>
81+
82+
```typescript
83+
import { PowertoolsLayerProps } from 'cdk-lambda-powertools-python-layer'
84+
85+
const powertoolsLayerProps: PowertoolsLayerProps = { ... }
86+
```
87+
88+
#### Properties <a name="Properties" id="properties"></a>
89+
90+
| **Name** | **Type** | **Description** |
91+
| --- | --- | --- |
92+
| [`includeExtras`](#cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyincludeextras) | `boolean` | A flag for the pydantic extras dependency, used for parsing. |
93+
| [`version`](#cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyversion) | `string` | The powertools package version from pypi repository. |
94+
95+
---
96+
97+
##### `includeExtras`<sup>Optional</sup> <a name="cdk-lambda-powertools-python-layer.PowertoolsLayerProps.property.includeExtras" id="cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyincludeextras"></a>
98+
99+
```typescript
100+
public readonly includeExtras: boolean;
101+
```
102+
103+
- *Type:* `boolean`
104+
105+
A flag for the pydantic extras dependency, used for parsing.
106+
107+
This will increase the size of the layer significantly. If you don't use parsing, ignore it.
108+
109+
---
110+
111+
##### `version`<sup>Optional</sup> <a name="cdk-lambda-powertools-python-layer.PowertoolsLayerProps.property.version" id="cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyversion"></a>
112+
113+
```typescript
114+
public readonly version: string;
115+
```
116+
117+
- *Type:* `string`
118+
119+
The powertools package version from pypi repository.
120+
121+
---
122+
123+
124+

package.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

yarn.lock

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)