Skip to content

Commit a3a9bf3

Browse files
author
github-actions
committed
chore: self mutation
Signed-off-by: github-actions <github-actions@github.com>
1 parent 873048f commit a3a9bf3

File tree

2 files changed

+68
-2
lines changed

2 files changed

+68
-2
lines changed

docs/classes/Generator.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
### Properties
1818

19+
- [handlerRole](Generator.md#handlerrole)
1920
- [node](Generator.md#node)
2021

2122
### Accessors
@@ -53,6 +54,18 @@ BucketDeployment.constructor
5354

5455
## Properties
5556

57+
### handlerRole
58+
59+
`Readonly` **handlerRole**: `IRole`
60+
61+
Execution role of the Lambda function behind the custom CloudFormation resource of type `Custom::CDKBucketDeployment`.
62+
63+
#### Inherited from
64+
65+
BucketDeployment.handlerRole
66+
67+
___
68+
5669
### node
5770

5871
`Readonly` **node**: `Node`

docs/interfaces/GeneratorProps.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@
3030
- [fileName](GeneratorProps.md#filename)
3131
- [fileType](GeneratorProps.md#filetype)
3232
- [include](GeneratorProps.md#include)
33+
- [logGroup](GeneratorProps.md#loggroup)
3334
- [logRetention](GeneratorProps.md#logretention)
3435
- [memoryLimit](GeneratorProps.md#memorylimit)
3536
- [metadata](GeneratorProps.md#metadata)
37+
- [outputObjectKeys](GeneratorProps.md#outputobjectkeys)
3638
- [prune](GeneratorProps.md#prune)
3739
- [retainOnDelete](GeneratorProps.md#retainondelete)
3840
- [role](GeneratorProps.md#role)
@@ -205,9 +207,12 @@ ___
205207

206208
`Optional` `Readonly` **destinationKeyPrefix**: `string`
207209

208-
Key prefix in the destination bucket.
210+
Key prefix in the destination bucket. Must be <=104 characters
209211

210-
Must be <=104 characters
212+
If it's set with prune: true, it will only prune files with the prefix.
213+
214+
We recommend to always configure the `destinationKeyPrefix` property. This will prevent the deployment
215+
from accidentally deleting data that wasn't uploaded by it.
211216

212217
**`Default`**
213218

@@ -383,12 +388,36 @@ Omit.include
383388

384389
___
385390

391+
### logGroup
392+
393+
`Optional` `Readonly` **logGroup**: `ILogGroup`
394+
395+
The Log Group used for logging of events emitted by the custom resource's lambda function.
396+
397+
Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16.
398+
If you are deploying to another type of region, please check regional availability first.
399+
400+
**`Default`**
401+
402+
```ts
403+
- a default log group created by AWS Lambda
404+
```
405+
406+
#### Inherited from
407+
408+
Omit.logGroup
409+
410+
___
411+
386412
### logRetention
387413

388414
`Optional` `Readonly` **logRetention**: `RetentionDays`
389415

390416
The number of days that the lambda function's log events are kept in CloudWatch Logs.
391417

418+
This is a legacy API and we strongly recommend you migrate to `logGroup` if you can.
419+
`logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.
420+
392421
**`Default`**
393422

394423
```ts
@@ -449,10 +478,34 @@ Omit.metadata
449478

450479
___
451480

481+
### outputObjectKeys
482+
483+
`Optional` `Readonly` **outputObjectKeys**: `boolean`
484+
485+
If set to false, the custom resource will not send back the SourceObjectKeys.
486+
This is useful when you are facing the error `Response object is too long`
487+
488+
See https://github.com/aws/aws-cdk/issues/28579
489+
490+
**`Default`**
491+
492+
```ts
493+
true
494+
```
495+
496+
#### Inherited from
497+
498+
Omit.outputObjectKeys
499+
500+
___
501+
452502
### prune
453503

454504
`Optional` `Readonly` **prune**: `boolean`
455505

506+
By default, files in the destination bucket that don't exist in the source will be deleted
507+
when the BucketDeployment resource is created or updated.
508+
456509
If this is set to false, files in the destination bucket that
457510
do not exist in the asset, will NOT be deleted during deployment (create/update).
458511

0 commit comments

Comments
 (0)