Skip to content

Commit 8a57210

Browse files
yicryicr
authored
chore(deps): upgrade dependencies (#20)
Upgrades project dependencies. See details in [workflow run]. [Workflow Run]: https://github.com/yicr/secure-frontend-web-app-cloudfront-distribution/actions/runs/4206490634 ------ *Automatically created by projen via the "upgrade-main" workflow*
1 parent 5278a4c commit 8a57210

File tree

3 files changed

+400
-19
lines changed

3 files changed

+400
-19
lines changed

‎API.md.md‎

Lines changed: 381 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,381 @@
1+
# API Reference <a name="API Reference" id="api-reference"></a>
2+
3+
## Constructs <a name="Constructs" id="Constructs"></a>
4+
5+
### SecureFrontendWebAppCloudFrontDistribution <a name="SecureFrontendWebAppCloudFrontDistribution" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution"></a>
6+
7+
#### Initializers <a name="Initializers" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer"></a>
8+
9+
```typescript
10+
import { SecureFrontendWebAppCloudFrontDistribution } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
11+
12+
new SecureFrontendWebAppCloudFrontDistribution(scope: Construct, id: string, props: SecureFrontendWebAppCloudFrontDistributionProps)
13+
```
14+
15+
| **Name** | **Type** | **Description** |
16+
| --- | --- | --- |
17+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
18+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
19+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.props">props</a></code> | <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps">SecureFrontendWebAppCloudFrontDistributionProps</a></code> | *No description.* |
20+
21+
---
22+
23+
##### `scope`<sup>Required</sup> <a name="scope" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.scope"></a>
24+
25+
- *Type:* constructs.Construct
26+
27+
---
28+
29+
##### `id`<sup>Required</sup> <a name="id" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.id"></a>
30+
31+
- *Type:* string
32+
33+
---
34+
35+
##### `props`<sup>Required</sup> <a name="props" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.Initializer.parameter.props"></a>
36+
37+
- *Type:* <a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps">SecureFrontendWebAppCloudFrontDistributionProps</a>
38+
39+
---
40+
41+
#### Methods <a name="Methods" id="Methods"></a>
42+
43+
| **Name** | **Description** |
44+
| --- | --- |
45+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.toString">toString</a></code> | Returns a string representation of this construct. |
46+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
47+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.addBehavior">addBehavior</a></code> | Adds a new behavior to this distribution for the given pathPattern. |
48+
49+
---
50+
51+
##### `toString` <a name="toString" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.toString"></a>
52+
53+
```typescript
54+
public toString(): string
55+
```
56+
57+
Returns a string representation of this construct.
58+
59+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.applyRemovalPolicy"></a>
60+
61+
```typescript
62+
public applyRemovalPolicy(policy: RemovalPolicy): void
63+
```
64+
65+
Apply the given removal policy to this resource.
66+
67+
The Removal Policy controls what happens to this resource when it stops
68+
being managed by CloudFormation, either because you've removed it from the
69+
CDK application or because you've made a change that requires the resource
70+
to be replaced.
71+
72+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
73+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
74+
75+
###### `policy`<sup>Required</sup> <a name="policy" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.applyRemovalPolicy.parameter.policy"></a>
76+
77+
- *Type:* aws-cdk-lib.RemovalPolicy
78+
79+
---
80+
81+
##### `addBehavior` <a name="addBehavior" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.addBehavior"></a>
82+
83+
```typescript
84+
public addBehavior(pathPattern: string, origin: IOrigin, behaviorOptions?: AddBehaviorOptions): void
85+
```
86+
87+
Adds a new behavior to this distribution for the given pathPattern.
88+
89+
###### `pathPattern`<sup>Required</sup> <a name="pathPattern" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.addBehavior.parameter.pathPattern"></a>
90+
91+
- *Type:* string
92+
93+
the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to.
94+
95+
---
96+
97+
###### `origin`<sup>Required</sup> <a name="origin" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.addBehavior.parameter.origin"></a>
98+
99+
- *Type:* aws-cdk-lib.aws_cloudfront.IOrigin
100+
101+
the origin to use for this behavior.
102+
103+
---
104+
105+
###### `behaviorOptions`<sup>Optional</sup> <a name="behaviorOptions" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.addBehavior.parameter.behaviorOptions"></a>
106+
107+
- *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions
108+
109+
the options for the behavior at this path.
110+
111+
---
112+
113+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
114+
115+
| **Name** | **Description** |
116+
| --- | --- |
117+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
118+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
119+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
120+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes">fromDistributionAttributes</a></code> | Creates a Distribution construct that represents an external (imported) distribution. |
121+
122+
---
123+
124+
##### ~~`isConstruct`~~ <a name="isConstruct" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isConstruct"></a>
125+
126+
```typescript
127+
import { SecureFrontendWebAppCloudFrontDistribution } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
128+
129+
SecureFrontendWebAppCloudFrontDistribution.isConstruct(x: any)
130+
```
131+
132+
Checks if `x` is a construct.
133+
134+
###### `x`<sup>Required</sup> <a name="x" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isConstruct.parameter.x"></a>
135+
136+
- *Type:* any
137+
138+
Any object.
139+
140+
---
141+
142+
##### `isOwnedResource` <a name="isOwnedResource" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isOwnedResource"></a>
143+
144+
```typescript
145+
import { SecureFrontendWebAppCloudFrontDistribution } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
146+
147+
SecureFrontendWebAppCloudFrontDistribution.isOwnedResource(construct: IConstruct)
148+
```
149+
150+
Returns true if the construct was created by CDK, and false otherwise.
151+
152+
###### `construct`<sup>Required</sup> <a name="construct" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isOwnedResource.parameter.construct"></a>
153+
154+
- *Type:* constructs.IConstruct
155+
156+
---
157+
158+
##### `isResource` <a name="isResource" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isResource"></a>
159+
160+
```typescript
161+
import { SecureFrontendWebAppCloudFrontDistribution } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
162+
163+
SecureFrontendWebAppCloudFrontDistribution.isResource(construct: IConstruct)
164+
```
165+
166+
Check whether the given construct is a Resource.
167+
168+
###### `construct`<sup>Required</sup> <a name="construct" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.isResource.parameter.construct"></a>
169+
170+
- *Type:* constructs.IConstruct
171+
172+
---
173+
174+
##### `fromDistributionAttributes` <a name="fromDistributionAttributes" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes"></a>
175+
176+
```typescript
177+
import { SecureFrontendWebAppCloudFrontDistribution } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
178+
179+
SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes(scope: Construct, id: string, attrs: DistributionAttributes)
180+
```
181+
182+
Creates a Distribution construct that represents an external (imported) distribution.
183+
184+
###### `scope`<sup>Required</sup> <a name="scope" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes.parameter.scope"></a>
185+
186+
- *Type:* constructs.Construct
187+
188+
---
189+
190+
###### `id`<sup>Required</sup> <a name="id" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes.parameter.id"></a>
191+
192+
- *Type:* string
193+
194+
---
195+
196+
###### `attrs`<sup>Required</sup> <a name="attrs" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.fromDistributionAttributes.parameter.attrs"></a>
197+
198+
- *Type:* aws-cdk-lib.aws_cloudfront.DistributionAttributes
199+
200+
---
201+
202+
#### Properties <a name="Properties" id="Properties"></a>
203+
204+
| **Name** | **Type** | **Description** |
205+
| --- | --- | --- |
206+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
207+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
208+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
209+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.distributionDomainName">distributionDomainName</a></code> | <code>string</code> | The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. |
210+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.distributionId">distributionId</a></code> | <code>string</code> | The distribution ID for this distribution. |
211+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.domainName">domainName</a></code> | <code>string</code> | The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. |
212+
213+
---
214+
215+
##### `node`<sup>Required</sup> <a name="node" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.node"></a>
216+
217+
```typescript
218+
public readonly node: Node;
219+
```
220+
221+
- *Type:* constructs.Node
222+
223+
The tree node.
224+
225+
---
226+
227+
##### `env`<sup>Required</sup> <a name="env" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.env"></a>
228+
229+
```typescript
230+
public readonly env: ResourceEnvironment;
231+
```
232+
233+
- *Type:* aws-cdk-lib.ResourceEnvironment
234+
235+
The environment this resource belongs to.
236+
237+
For resources that are created and managed by the CDK
238+
(generally, those created by creating new class instances like Role, Bucket, etc.),
239+
this is always the same as the environment of the stack they belong to;
240+
however, for imported resources
241+
(those obtained from static methods like fromRoleArn, fromBucketName, etc.),
242+
that might be different than the stack they were imported into.
243+
244+
---
245+
246+
##### `stack`<sup>Required</sup> <a name="stack" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.stack"></a>
247+
248+
```typescript
249+
public readonly stack: Stack;
250+
```
251+
252+
- *Type:* aws-cdk-lib.Stack
253+
254+
The stack in which this resource is defined.
255+
256+
---
257+
258+
##### `distributionDomainName`<sup>Required</sup> <a name="distributionDomainName" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.distributionDomainName"></a>
259+
260+
```typescript
261+
public readonly distributionDomainName: string;
262+
```
263+
264+
- *Type:* string
265+
266+
The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
267+
268+
---
269+
270+
##### `distributionId`<sup>Required</sup> <a name="distributionId" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.distributionId"></a>
271+
272+
```typescript
273+
public readonly distributionId: string;
274+
```
275+
276+
- *Type:* string
277+
278+
The distribution ID for this distribution.
279+
280+
---
281+
282+
##### `domainName`<sup>Required</sup> <a name="domainName" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistribution.property.domainName"></a>
283+
284+
```typescript
285+
public readonly domainName: string;
286+
```
287+
288+
- *Type:* string
289+
290+
The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.
291+
292+
---
293+
294+
295+
## Structs <a name="Structs" id="Structs"></a>
296+
297+
### SecureFrontendWebAppCloudFrontDistributionProps <a name="SecureFrontendWebAppCloudFrontDistributionProps" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps"></a>
298+
299+
#### Initializer <a name="Initializer" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.Initializer"></a>
300+
301+
```typescript
302+
import { SecureFrontendWebAppCloudFrontDistributionProps } from '@yicr/secure-frontend-web-app-cloudfront-distribution'
303+
304+
const secureFrontendWebAppCloudFrontDistributionProps: SecureFrontendWebAppCloudFrontDistributionProps = { ... }
305+
```
306+
307+
#### Properties <a name="Properties" id="Properties"></a>
308+
309+
| **Name** | **Type** | **Description** |
310+
| --- | --- | --- |
311+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.accessLogBucket">accessLogBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | *No description.* |
312+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.certificate">certificate</a></code> | <code>aws-cdk-lib.aws_certificatemanager.ICertificate</code> | *No description.* |
313+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
314+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.originAccessIdentity">originAccessIdentity</a></code> | <code>aws-cdk-lib.aws_cloudfront.IOriginAccessIdentity</code> | *No description.* |
315+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.originBucket">originBucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | *No description.* |
316+
| <code><a href="#@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.comment">comment</a></code> | <code>string</code> | *No description.* |
317+
318+
---
319+
320+
##### `accessLogBucket`<sup>Required</sup> <a name="accessLogBucket" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.accessLogBucket"></a>
321+
322+
```typescript
323+
public readonly accessLogBucket: IBucket;
324+
```
325+
326+
- *Type:* aws-cdk-lib.aws_s3.IBucket
327+
328+
---
329+
330+
##### `certificate`<sup>Required</sup> <a name="certificate" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.certificate"></a>
331+
332+
```typescript
333+
public readonly certificate: ICertificate;
334+
```
335+
336+
- *Type:* aws-cdk-lib.aws_certificatemanager.ICertificate
337+
338+
---
339+
340+
##### `domainName`<sup>Required</sup> <a name="domainName" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.domainName"></a>
341+
342+
```typescript
343+
public readonly domainName: string;
344+
```
345+
346+
- *Type:* string
347+
348+
---
349+
350+
##### `originAccessIdentity`<sup>Required</sup> <a name="originAccessIdentity" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.originAccessIdentity"></a>
351+
352+
```typescript
353+
public readonly originAccessIdentity: IOriginAccessIdentity;
354+
```
355+
356+
- *Type:* aws-cdk-lib.aws_cloudfront.IOriginAccessIdentity
357+
358+
---
359+
360+
##### `originBucket`<sup>Required</sup> <a name="originBucket" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.originBucket"></a>
361+
362+
```typescript
363+
public readonly originBucket: IBucket;
364+
```
365+
366+
- *Type:* aws-cdk-lib.aws_s3.IBucket
367+
368+
---
369+
370+
##### `comment`<sup>Optional</sup> <a name="comment" id="@yicr/secure-frontend-web-app-cloudfront-distribution.SecureFrontendWebAppCloudFrontDistributionProps.property.comment"></a>
371+
372+
```typescript
373+
public readonly comment: string;
374+
```
375+
376+
- *Type:* string
377+
378+
---
379+
380+
381+

‎package.json‎

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

0 commit comments

Comments
 (0)