2
2
3
3
## Constructs <a name =" Constructs " id =" constructs " ></a >
4
4
5
- ### LambdaPowertoolsLayer <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayer " ></a >
5
+ ### LambdaPowertoolsLayer <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer " id =" cdkawslambdapowertoolslayerlambdapowertoolslayer " ></a >
6
6
7
7
Defines a new Lambda Layer with Powertools for python library.
8
8
9
- #### Initializers <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.Initializer " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerinitializer " ></a >
9
+ #### Initializers <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.Initializer " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerinitializer " ></a >
10
10
11
11
``` typescript
12
- import { LambdaPowertoolsLayer } from ' cdk-lambda-powertools-python -layer'
12
+ import { LambdaPowertoolsLayer } from ' cdk-aws- lambda-powertools-layer'
13
13
14
14
new LambdaPowertoolsLayer (scope : Construct , id : string , props ?: PowertoolsLayerProps )
15
15
```
16
16
17
17
| ** Name** | ** Type** | ** Description** |
18
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.* |
19
+ | [ ` scope ` ] ( #cdkawslambdapowertoolslayerlambdapowertoolslayerparameterscope ) <span title =" Required " >* </span > | [ ` constructs.Construct ` ] ( #constructs.Construct ) | * No description.* |
20
+ | [ ` id ` ] ( #cdkawslambdapowertoolslayerlambdapowertoolslayerparameterid ) <span title =" Required " >* </span > | ` string ` | * No description.* |
21
+ | [ ` props ` ] ( #cdkawslambdapowertoolslayerlambdapowertoolslayerparameterprops ) | [ ` cdk-aws- lambda-powertools-layer.PowertoolsLayerProps ` ] ( #cdk-aws- lambda-powertools-layer.PowertoolsLayerProps ) | * No description.* |
22
22
23
23
---
24
24
25
- ##### ` scope ` <sup >Required</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.scope " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterscope " ></a >
25
+ ##### ` scope ` <sup >Required</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.scope " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterscope " ></a >
26
26
27
27
- * Type:* [ ` constructs.Construct ` ] ( #constructs.Construct )
28
28
29
29
---
30
30
31
- ##### ` id ` <sup >Required</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.id " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterid " ></a >
31
+ ##### ` id ` <sup >Required</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.id " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterid " ></a >
32
32
33
33
- * Type:* ` string `
34
34
35
35
---
36
36
37
- ##### ` props ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.props " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterprops " ></a >
37
+ ##### ` props ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.props " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterprops " ></a >
38
38
39
- - * Type:* [ ` cdk-lambda-powertools-python- layer.PowertoolsLayerProps ` ] ( #cdk-lambda-powertools-python -layer.PowertoolsLayerProps )
39
+ - * Type:* [ ` cdk-aws- lambda-powertools-layer.PowertoolsLayerProps ` ] ( #cdk-aws- lambda-powertools-layer.PowertoolsLayerProps )
40
40
41
41
---
42
42
@@ -45,31 +45,31 @@ new LambdaPowertoolsLayer(scope: Construct, id: string, props?: PowertoolsLayerP
45
45
46
46
| ** Name** | ** Description** |
47
47
| --- | --- |
48
- | [ ` constructBuildArgs ` ] ( #cdklambdapowertoolspythonlayerlambdapowertoolslayerconstructbuildargs ) | creates build argument for the Dockerfile. |
48
+ | [ ` constructBuildArgs ` ] ( #cdkawslambdapowertoolslayerlambdapowertoolslayerconstructbuildargs ) | creates build argument for the Dockerfile. |
49
49
50
50
---
51
51
52
- ##### ` constructBuildArgs ` <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.constructBuildArgs " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerconstructbuildargs " ></a >
52
+ ##### ` constructBuildArgs ` <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.constructBuildArgs " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerconstructbuildargs " ></a >
53
53
54
54
``` typescript
55
- import { LambdaPowertoolsLayer } from ' cdk-lambda-powertools-python -layer'
55
+ import { LambdaPowertoolsLayer } from ' cdk-aws- lambda-powertools-layer'
56
56
57
57
LambdaPowertoolsLayer .constructBuildArgs (runtimeFamily : RuntimeFamily , includeExtras ?: boolean , version ?: string )
58
58
```
59
59
60
- ###### ` runtimeFamily ` <sup >Required</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.runtimeFamily " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterruntimefamily " ></a >
60
+ ###### ` runtimeFamily ` <sup >Required</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.runtimeFamily " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterruntimefamily " ></a >
61
61
62
62
- * Type:* [ ` aws-cdk-lib.aws_lambda.RuntimeFamily ` ] ( #aws-cdk-lib.aws_lambda.RuntimeFamily )
63
63
64
64
---
65
65
66
- ###### ` includeExtras ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.includeExtras " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterincludeextras " ></a >
66
+ ###### ` includeExtras ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.includeExtras " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterincludeextras " ></a >
67
67
68
68
- * Type:* ` boolean `
69
69
70
70
---
71
71
72
- ###### ` version ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.LambdaPowertoolsLayer.parameter.version " id =" cdklambdapowertoolspythonlayerlambdapowertoolslayerparameterversion " ></a >
72
+ ###### ` version ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.LambdaPowertoolsLayer.parameter.version " id =" cdkawslambdapowertoolslayerlambdapowertoolslayerparameterversion " ></a >
73
73
74
74
- * Type:* ` string `
75
75
@@ -79,14 +79,14 @@ LambdaPowertoolsLayer.constructBuildArgs(runtimeFamily: RuntimeFamily, includeEx
79
79
80
80
## Structs <a name =" Structs " id =" structs " ></a >
81
81
82
- ### PowertoolsLayerProps <a name =" cdk-lambda-powertools-python- layer.PowertoolsLayerProps " id =" cdklambdapowertoolspythonlayerpowertoolslayerprops " ></a >
82
+ ### PowertoolsLayerProps <a name =" cdk-aws- lambda-powertools-layer.PowertoolsLayerProps " id =" cdkawslambdapowertoolslayerpowertoolslayerprops " ></a >
83
83
84
84
Properties for Powertools layer for python.
85
85
86
86
#### Initializer <a name =" [object Object].Initializer " id =" object-objectinitializer " ></a >
87
87
88
88
``` typescript
89
- import { PowertoolsLayerProps } from ' cdk-lambda-powertools-python -layer'
89
+ import { PowertoolsLayerProps } from ' cdk-aws- lambda-powertools-layer'
90
90
91
91
const powertoolsLayerProps: PowertoolsLayerProps = { ... }
92
92
```
@@ -95,14 +95,14 @@ const powertoolsLayerProps: PowertoolsLayerProps = { ... }
95
95
96
96
| ** Name** | ** Type** | ** Description** |
97
97
| --- | --- | --- |
98
- | [ ` includeExtras ` ] ( #cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyincludeextras ) | ` boolean ` | A flag for the pydantic extras dependency, used for parsing. |
99
- | [ ` layerVersionName ` ] ( #cdklambdapowertoolspythonlayerpowertoolslayerpropspropertylayerversionname ) | ` string ` | the name of the layer, will be randomised if empty. |
100
- | [ ` runtimeFamily ` ] ( #cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyruntimefamily ) | [ ` aws-cdk-lib.aws_lambda.RuntimeFamily ` ] ( #aws-cdk-lib.aws_lambda.RuntimeFamily ) | the runtime of the layer. |
101
- | [ ` version ` ] ( #cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyversion ) | ` string ` | The powertools package version from pypi repository. |
98
+ | [ ` includeExtras ` ] ( #cdkawslambdapowertoolslayerpowertoolslayerpropspropertyincludeextras ) | ` boolean ` | A flag for the pydantic extras dependency, used for parsing. |
99
+ | [ ` layerVersionName ` ] ( #cdkawslambdapowertoolslayerpowertoolslayerpropspropertylayerversionname ) | ` string ` | the name of the layer, will be randomised if empty. |
100
+ | [ ` runtimeFamily ` ] ( #cdkawslambdapowertoolslayerpowertoolslayerpropspropertyruntimefamily ) | [ ` aws-cdk-lib.aws_lambda.RuntimeFamily ` ] ( #aws-cdk-lib.aws_lambda.RuntimeFamily ) | the runtime of the layer. |
101
+ | [ ` version ` ] ( #cdkawslambdapowertoolslayerpowertoolslayerpropspropertyversion ) | ` string ` | The powertools package version from pypi repository. |
102
102
103
103
---
104
104
105
- ##### ` includeExtras ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.PowertoolsLayerProps.property.includeExtras " id =" cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyincludeextras " ></a >
105
+ ##### ` includeExtras ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.PowertoolsLayerProps.property.includeExtras " id =" cdkawslambdapowertoolslayerpowertoolslayerpropspropertyincludeextras " ></a >
106
106
107
107
``` typescript
108
108
public readonly includeExtras : boolean ;
@@ -116,7 +116,7 @@ This will increase the size of the layer significantly. If you don't use parsing
116
116
117
117
---
118
118
119
- ##### ` layerVersionName ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.PowertoolsLayerProps.property.layerVersionName " id =" cdklambdapowertoolspythonlayerpowertoolslayerpropspropertylayerversionname " ></a >
119
+ ##### ` layerVersionName ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.PowertoolsLayerProps.property.layerVersionName " id =" cdkawslambdapowertoolslayerpowertoolslayerpropspropertylayerversionname " ></a >
120
120
121
121
``` typescript
122
122
public readonly layerVersionName : string ;
@@ -128,7 +128,7 @@ the name of the layer, will be randomised if empty.
128
128
129
129
---
130
130
131
- ##### ` runtimeFamily ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.PowertoolsLayerProps.property.runtimeFamily " id =" cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyruntimefamily " ></a >
131
+ ##### ` runtimeFamily ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.PowertoolsLayerProps.property.runtimeFamily " id =" cdkawslambdapowertoolslayerpowertoolslayerpropspropertyruntimefamily " ></a >
132
132
133
133
``` typescript
134
134
public readonly runtimeFamily : RuntimeFamily ;
@@ -140,7 +140,7 @@ the runtime of the layer.
140
140
141
141
---
142
142
143
- ##### ` version ` <sup >Optional</sup > <a name =" cdk-lambda-powertools-python- layer.PowertoolsLayerProps.property.version " id =" cdklambdapowertoolspythonlayerpowertoolslayerpropspropertyversion " ></a >
143
+ ##### ` version ` <sup >Optional</sup > <a name =" cdk-aws- lambda-powertools-layer.PowertoolsLayerProps.property.version " id =" cdkawslambdapowertoolslayerpowertoolslayerpropspropertyversion " ></a >
144
144
145
145
``` typescript
146
146
public readonly version : string ;
0 commit comments