Skip to content

Commit c04d96a

Browse files
hupe1980hupe1980
committed
chore: Update doc
1 parent 32028a3 commit c04d96a

File tree

1 file changed

+151
-28
lines changed
  • packages/cdk-lambda-at-edge-pattern

1 file changed

+151
-28
lines changed

‎packages/cdk-lambda-at-edge-pattern/API.md

Lines changed: 151 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
Name|Description
66
----|-----------
7+
[BaseEdgeConstruct](#cloudcomponents-cdk-lambda-at-edge-pattern-baseedgeconstruct)|*No description*
78
[EdgeFunction](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction)|*No description*
9+
[EdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-edgerole)|*No description*
810
[HttpHeaders](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheaders)|*No description*
911
[WithConfiguration](#cloudcomponents-cdk-lambda-at-edge-pattern-withconfiguration)|*No description*
1012

@@ -16,6 +18,7 @@ Name|Description
1618
[CommonEdgeFunctionProps](#cloudcomponents-cdk-lambda-at-edge-pattern-commonedgefunctionprops)|*No description*
1719
[Configuration](#cloudcomponents-cdk-lambda-at-edge-pattern-configuration)|*No description*
1820
[EdgeFunctionProps](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunctionprops)|*No description*
21+
[EdgeRoleProps](#cloudcomponents-cdk-lambda-at-edge-pattern-edgeroleprops)|*No description*
1922
[HttpHeadersProps](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheadersprops)|*No description*
2023
[WithConfigurationProps](#cloudcomponents-cdk-lambda-at-edge-pattern-withconfigurationprops)|*No description*
2124

@@ -24,6 +27,8 @@ Name|Description
2427

2528
Name|Description
2629
----|-----------
30+
[IEdgeLambda](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgelambda)|*No description*
31+
[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)|*No description*
2732
[ILambdaFunctionAssociation](#cloudcomponents-cdk-lambda-at-edge-pattern-ilambdafunctionassociation)|*No description*
2833

2934

@@ -35,7 +40,7 @@ Name|Description
3540

3641

3742

38-
## class EdgeFunction <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction"></a>
43+
## class BaseEdgeConstruct <a id="cloudcomponents-cdk-lambda-at-edge-pattern-baseedgeconstruct"></a>
3944

4045

4146

@@ -47,21 +52,88 @@ __Extends__: [Construct](#aws-cdk-core-construct)
4752

4853

4954

55+
```ts
56+
new BaseEdgeConstruct(scope: Construct, id: string)
57+
```
58+
59+
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
60+
* **id** (<code>string</code>) *No description*
61+
62+
63+
64+
### Properties
65+
66+
67+
Name | Type | Description
68+
-----|------|-------------
69+
**edgeStack** | <code>[Stack](#aws-cdk-core-stack)</code> | <span></span>
70+
**stack** | <code>[Stack](#aws-cdk-core-stack)</code> | <span></span>
71+
72+
73+
74+
## class EdgeFunction <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction"></a>
75+
76+
77+
78+
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [ILambdaFunctionAssociation](#cloudcomponents-cdk-lambda-at-edge-pattern-ilambdafunctionassociation), [IEdgeLambda](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgelambda)
79+
__Extends__: [BaseEdgeConstruct](#cloudcomponents-cdk-lambda-at-edge-pattern-baseedgeconstruct)
80+
81+
### Initializer
82+
83+
84+
85+
5086
```ts
5187
new EdgeFunction(scope: Construct, id: string, props: EdgeFunctionProps)
5288
```
5389

5490
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
5591
* **id** (<code>string</code>) *No description*
5692
* **props** (<code>[EdgeFunctionProps](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunctionprops)</code>) *No description*
57-
* **logLevel** (<code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code>) *No description* __*Optional*__
93+
* **edgeRole** (<code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code>) *No description* __*Optional*__
5894
* **parameterName** (<code>string</code>) The name of the parameter. __*Optional*__
59-
* **role** (<code>[IRole](#aws-cdk-aws-iam-irole)</code>) *No description* __*Optional*__
6095
* **code** (<code>[Code](#aws-cdk-aws-lambda-code)</code>) *No description*
96+
* **configuration** (<code>[Configuration](#cloudcomponents-cdk-lambda-at-edge-pattern-configuration)</code>) *No description*
97+
* **eventType** (<code>[LambdaEdgeEventType](#aws-cdk-aws-cloudfront-lambdaedgeeventtype)</code>) *No description*
6198
* **name** (<code>string</code>) *No description*
6299

63100

64101

102+
### Properties
103+
104+
105+
Name | Type | Description
106+
-----|------|-------------
107+
**edgeRole** | <code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code> | <span></span>
108+
**eventType** | <code>[LambdaEdgeEventType](#aws-cdk-aws-cloudfront-lambdaedgeeventtype)</code> | <span></span>
109+
**functionVersion** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
110+
**lambdaFunction** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
111+
112+
113+
114+
## class EdgeRole <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgerole"></a>
115+
116+
117+
118+
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)
119+
__Extends__: [BaseEdgeConstruct](#cloudcomponents-cdk-lambda-at-edge-pattern-baseedgeconstruct)
120+
121+
### Initializer
122+
123+
124+
125+
126+
```ts
127+
new EdgeRole(scope: Construct, id: string, props?: EdgeRoleProps)
128+
```
129+
130+
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
131+
* **id** (<code>string</code>) *No description*
132+
* **props** (<code>[EdgeRoleProps](#cloudcomponents-cdk-lambda-at-edge-pattern-edgeroleprops)</code>) *No description*
133+
* **roleName** (<code>string</code>) *No description* __*Optional*__
134+
135+
136+
65137
### Properties
66138

67139

@@ -72,27 +144,27 @@ Name | Type | Description
72144
### Methods
73145

74146

75-
#### retrieveEdgeFunction(scope) <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction-retrieveedgefunction"></a>
147+
#### addToEdgeRolePolicy(statement) <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgerole-addtoedgerolepolicy"></a>
76148

77149

78150

79151
```ts
80-
retrieveEdgeFunction(scope: Construct): IFunction
152+
addToEdgeRolePolicy(statement: PolicyStatement): void
81153
```
82154

83-
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
155+
* **statement** (<code>[PolicyStatement](#aws-cdk-aws-iam-policystatement)</code>) *No description*
156+
157+
84158

85-
__Returns__:
86-
* <code>[IFunction](#aws-cdk-aws-lambda-ifunction)</code>
87159

88160

89161

90162
## class HttpHeaders <a id="cloudcomponents-cdk-lambda-at-edge-pattern-httpheaders"></a>
91163

92164

93165

94-
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [ILambdaFunctionAssociation](#cloudcomponents-cdk-lambda-at-edge-pattern-ilambdafunctionassociation)
95-
__Extends__: [Construct](#aws-cdk-core-construct)
166+
__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable), [ILambdaFunctionAssociation](#cloudcomponents-cdk-lambda-at-edge-pattern-ilambdafunctionassociation), [IEdgeLambda](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgelambda)
167+
__Extends__: [EdgeFunction](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction)
96168

97169
### Initializer
98170

@@ -106,22 +178,13 @@ new HttpHeaders(scope: Construct, id: string, props: HttpHeadersProps)
106178
* **scope** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
107179
* **id** (<code>string</code>) *No description*
108180
* **props** (<code>[HttpHeadersProps](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheadersprops)</code>) *No description*
109-
* **logLevel** (<code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code>) *No description* __*Optional*__
181+
* **edgeRole** (<code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code>) *No description* __*Optional*__
110182
* **parameterName** (<code>string</code>) The name of the parameter. __*Optional*__
111-
* **role** (<code>[IRole](#aws-cdk-aws-iam-irole)</code>) *No description* __*Optional*__
112183
* **httpHeaders** (<code>Map<string, string></code>) *No description*
184+
* **logLevel** (<code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code>) *No description* __*Optional*__
113185

114186

115187

116-
### Properties
117-
118-
119-
Name | Type | Description
120-
-----|------|-------------
121-
**eventType** | <code>[LambdaEdgeEventType](#aws-cdk-aws-cloudfront-lambdaedgeeventtype)</code> | <span></span>
122-
**lambdaFunction** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
123-
124-
125188

126189
## class WithConfiguration <a id="cloudcomponents-cdk-lambda-at-edge-pattern-withconfiguration"></a>
127190

@@ -152,7 +215,7 @@ new WithConfiguration(scope: Construct, id: string, props: WithConfigurationProp
152215

153216
Name | Type | Description
154217
-----|------|-------------
155-
**lambdaFunction** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
218+
**functionVersion** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
156219

157220

158221

@@ -165,9 +228,8 @@ Name | Type | Description
165228

166229
Name | Type | Description
167230
-----|------|-------------
168-
**logLevel**? | <code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code> | __*Optional*__
231+
**edgeRole**? | <code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code> | __*Optional*__
169232
**parameterName**? | <code>string</code> | The name of the parameter.<br/>__*Optional*__
170-
**role**? | <code>[IRole](#aws-cdk-aws-iam-irole)</code> | __*Optional*__
171233

172234

173235

@@ -194,10 +256,24 @@ Name | Type | Description
194256
Name | Type | Description
195257
-----|------|-------------
196258
**code** | <code>[Code](#aws-cdk-aws-lambda-code)</code> | <span></span>
259+
**configuration** | <code>[Configuration](#cloudcomponents-cdk-lambda-at-edge-pattern-configuration)</code> | <span></span>
260+
**eventType** | <code>[LambdaEdgeEventType](#aws-cdk-aws-cloudfront-lambdaedgeeventtype)</code> | <span></span>
197261
**name** | <code>string</code> | <span></span>
198-
**logLevel**? | <code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code> | __*Optional*__
262+
**edgeRole**? | <code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code> | __*Optional*__
199263
**parameterName**? | <code>string</code> | The name of the parameter.<br/>__*Optional*__
200-
**role**? | <code>[IRole](#aws-cdk-aws-iam-irole)</code> | __*Optional*__
264+
265+
266+
267+
## struct EdgeRoleProps <a id="cloudcomponents-cdk-lambda-at-edge-pattern-edgeroleprops"></a>
268+
269+
270+
271+
272+
273+
274+
Name | Type | Description
275+
-----|------|-------------
276+
**roleName**? | <code>string</code> | __*Optional*__
201277

202278

203279

@@ -211,15 +287,62 @@ Name | Type | Description
211287
Name | Type | Description
212288
-----|------|-------------
213289
**httpHeaders** | <code>Map<string, string></code> | <span></span>
290+
**edgeRole**? | <code>[IEdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole)</code> | __*Optional*__
214291
**logLevel**? | <code>[LogLevel](#cloudcomponents-cdk-lambda-at-edge-pattern-loglevel)</code> | __*Optional*__
215292
**parameterName**? | <code>string</code> | The name of the parameter.<br/>__*Optional*__
216-
**role**? | <code>[IRole](#aws-cdk-aws-iam-irole)</code> | __*Optional*__
293+
294+
295+
296+
## interface IEdgeLambda <a id="cloudcomponents-cdk-lambda-at-edge-pattern-iedgelambda"></a>
297+
298+
__Implemented by__: [EdgeFunction](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction), [HttpHeaders](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheaders)
299+
300+
301+
302+
### Properties
303+
304+
305+
Name | Type | Description
306+
-----|------|-------------
307+
**eventType** | <code>[LambdaEdgeEventType](#aws-cdk-aws-cloudfront-lambdaedgeeventtype)</code> | <span></span>
308+
**functionVersion** | <code>[IVersion](#aws-cdk-aws-lambda-iversion)</code> | <span></span>
309+
310+
311+
312+
## interface IEdgeRole <a id="cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole"></a>
313+
314+
__Implemented by__: [EdgeRole](#cloudcomponents-cdk-lambda-at-edge-pattern-edgerole)
315+
316+
317+
318+
### Properties
319+
320+
321+
Name | Type | Description
322+
-----|------|-------------
323+
**role** | <code>[IRole](#aws-cdk-aws-iam-irole)</code> | <span></span>
324+
325+
### Methods
326+
327+
328+
#### addToEdgeRolePolicy(statement) <a id="cloudcomponents-cdk-lambda-at-edge-pattern-iedgerole-addtoedgerolepolicy"></a>
329+
330+
331+
332+
```ts
333+
addToEdgeRolePolicy(statement: PolicyStatement): void
334+
```
335+
336+
* **statement** (<code>[PolicyStatement](#aws-cdk-aws-iam-policystatement)</code>) *No description*
337+
338+
339+
217340

218341

219342

220343
## interface ILambdaFunctionAssociation <a id="cloudcomponents-cdk-lambda-at-edge-pattern-ilambdafunctionassociation"></a>
221344

222-
__Implemented by__: [HttpHeaders](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheaders)
345+
__Implemented by__: [EdgeFunction](#cloudcomponents-cdk-lambda-at-edge-pattern-edgefunction), [HttpHeaders](#cloudcomponents-cdk-lambda-at-edge-pattern-httpheaders)
223346

224347

225348

0 commit comments

Comments
 (0)