Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/classes/Generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

### Properties

- [handlerRole](Generator.md#handlerrole)
- [node](Generator.md#node)

### Accessors
Expand Down Expand Up @@ -53,6 +54,18 @@ BucketDeployment.constructor

## Properties

### handlerRole

• `Readonly` **handlerRole**: `IRole`

Execution role of the Lambda function behind the custom CloudFormation resource of type `Custom::CDKBucketDeployment`.

#### Inherited from

BucketDeployment.handlerRole

___

### node

• `Readonly` **node**: `Node`
Expand Down
57 changes: 55 additions & 2 deletions docs/interfaces/GeneratorProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@
- [fileName](GeneratorProps.md#filename)
- [fileType](GeneratorProps.md#filetype)
- [include](GeneratorProps.md#include)
- [logGroup](GeneratorProps.md#loggroup)
- [logRetention](GeneratorProps.md#logretention)
- [memoryLimit](GeneratorProps.md#memorylimit)
- [metadata](GeneratorProps.md#metadata)
- [outputObjectKeys](GeneratorProps.md#outputobjectkeys)
- [prune](GeneratorProps.md#prune)
- [retainOnDelete](GeneratorProps.md#retainondelete)
- [role](GeneratorProps.md#role)
Expand Down Expand Up @@ -205,9 +207,12 @@ ___

• `Optional` `Readonly` **destinationKeyPrefix**: `string`

Key prefix in the destination bucket.
Key prefix in the destination bucket. Must be <=104 characters

Must be <=104 characters
If it's set with prune: true, it will only prune files with the prefix.

We recommend to always configure the `destinationKeyPrefix` property. This will prevent the deployment
from accidentally deleting data that wasn't uploaded by it.

**`Default`**

Expand Down Expand Up @@ -383,12 +388,36 @@ Omit.include

___

### logGroup

• `Optional` `Readonly` **logGroup**: `ILogGroup`

The Log Group used for logging of events emitted by the custom resource's lambda function.

Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16.
If you are deploying to another type of region, please check regional availability first.

**`Default`**

```ts
- a default log group created by AWS Lambda
```

#### Inherited from

Omit.logGroup

___

### logRetention

• `Optional` `Readonly` **logRetention**: `RetentionDays`

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

This is a legacy API and we strongly recommend you migrate to `logGroup` if you can.
`logGroup` allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.

**`Default`**

```ts
Expand Down Expand Up @@ -449,10 +478,34 @@ Omit.metadata

___

### outputObjectKeys

• `Optional` `Readonly` **outputObjectKeys**: `boolean`

If set to false, the custom resource will not send back the SourceObjectKeys.
This is useful when you are facing the error `Response object is too long`

See https://github.com/aws/aws-cdk/issues/28579

**`Default`**

```ts
true
```

#### Inherited from

Omit.outputObjectKeys

___

### prune

• `Optional` `Readonly` **prune**: `boolean`

By default, files in the destination bucket that don't exist in the source will be deleted
when the BucketDeployment resource is created or updated.

If this is set to false, files in the destination bucket that
do not exist in the asset, will NOT be deleted during deployment (create/update).

Expand Down
4 changes: 2 additions & 2 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

49 changes: 31 additions & 18 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.