|
30 | 30 | - [fileName](GeneratorProps.md#filename) |
31 | 31 | - [fileType](GeneratorProps.md#filetype) |
32 | 32 | - [include](GeneratorProps.md#include) |
| 33 | +- [logGroup](GeneratorProps.md#loggroup) |
33 | 34 | - [logRetention](GeneratorProps.md#logretention) |
34 | 35 | - [memoryLimit](GeneratorProps.md#memorylimit) |
35 | 36 | - [metadata](GeneratorProps.md#metadata) |
| 37 | +- [outputObjectKeys](GeneratorProps.md#outputobjectkeys) |
36 | 38 | - [prune](GeneratorProps.md#prune) |
37 | 39 | - [retainOnDelete](GeneratorProps.md#retainondelete) |
38 | 40 | - [role](GeneratorProps.md#role) |
|
205 | 207 |
|
206 | 208 | • `Optional` `Readonly` **destinationKeyPrefix**: `string` |
207 | 209 |
|
208 | | -Key prefix in the destination bucket. |
| 210 | +Key prefix in the destination bucket. Must be <=104 characters |
209 | 211 |
|
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. |
211 | 216 |
|
212 | 217 | **`Default`** |
213 | 218 |
|
@@ -383,12 +388,36 @@ Omit.include |
383 | 388 |
|
384 | 389 | ___ |
385 | 390 |
|
| 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 | + |
386 | 412 | ### logRetention |
387 | 413 |
|
388 | 414 | • `Optional` `Readonly` **logRetention**: `RetentionDays` |
389 | 415 |
|
390 | 416 | The number of days that the lambda function's log events are kept in CloudWatch Logs. |
391 | 417 |
|
| 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 | + |
392 | 421 | **`Default`** |
393 | 422 |
|
394 | 423 | ```ts |
@@ -449,10 +478,34 @@ Omit.metadata |
449 | 478 |
|
450 | 479 | ___ |
451 | 480 |
|
| 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 | + |
452 | 502 | ### prune |
453 | 503 |
|
454 | 504 | • `Optional` `Readonly` **prune**: `boolean` |
455 | 505 |
|
| 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 | + |
456 | 509 | If this is set to false, files in the destination bucket that |
457 | 510 | do not exist in the asset, will NOT be deleted during deployment (create/update). |
458 | 511 |
|
|
0 commit comments