From 03b0ba6f1116474ce3986b45b4212814d3d273ae Mon Sep 17 00:00:00 2001 From: cu-infra-svc-git <93961939+cu-infra-svc-git@users.noreply.github.com> Date: Mon, 6 May 2024 00:07:01 +0000 Subject: [PATCH 1/2] chore(deps): update dependency typedoc-plugin-markdown to v4 --- package.json | 2 +- yarn.lock | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index 13dabd2..49af5e8 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "ts-jest": "^27", "ts-node": "^10", "typedoc": "^0.25.1", - "typedoc-plugin-markdown": "^3.16.0", + "typedoc-plugin-markdown": "^4.0.0", "typescript": "^4.9.5" }, "peerDependencies": { diff --git a/yarn.lock b/yarn.lock index 416fd90..d64ec3e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6236,12 +6236,10 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc-plugin-markdown@^3.16.0: - version "3.16.0" - resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.16.0.tgz#98da250271aafade8b6740a8116a97cd3941abcd" - integrity sha512-eeiC78fDNGFwemPIHiwRC+mEC7W5jwt3fceUev2gJ2nFnXpVHo8eRrpC9BLWZDee6ehnz/sPmNjizbXwpfaTBw== - dependencies: - handlebars "^4.7.7" +typedoc-plugin-markdown@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.0.0.tgz#3e6dcfd5fab0f7634c26a71bfbd2cb4fac0b6d18" + integrity sha512-7cNKIGxGq1w9IvwWbm6jAASUCvlJeaANJXCOH+Fcvz2JrNIIMVbRu4j2Nq2zpDDaBHsrUmKVaz+F5vroMU8u4A== typedoc@^0.25.1: version "0.25.1" From 8014a86ff12dacab31ce7ab69b052d97400737bd Mon Sep 17 00:00:00 2001 From: github-actions Date: Mon, 6 May 2024 00:08:47 +0000 Subject: [PATCH 2/2] chore: self mutation Signed-off-by: github-actions --- docs/.nojekyll | 1 - docs/README.md | 14 +- docs/classes/Generator.md | 105 ++--- .../GeneratorFileType.md | 12 +- docs/interfaces/GeneratorProps.md | 399 ++++++++---------- docs/interfaces/SerializerProps.md | 16 +- docs/interfaces/UploadProps.md | 53 +-- 7 files changed, 263 insertions(+), 337 deletions(-) delete mode 100644 docs/.nojekyll rename docs/{enums => enumerations}/GeneratorFileType.md (54%) diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index e1bfb7b..3aaf1a1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,18 +1,18 @@ -@time-loop/cdk-s3-file-generator +**@time-loop/cdk-s3-file-generator** • **Docs** -# @time-loop/cdk-s3-file-generator +*** -## Table of contents +# @time-loop/cdk-s3-file-generator -### Enumerations +## Enumerations -- [GeneratorFileType](enums/GeneratorFileType.md) +- [GeneratorFileType](enumerations/GeneratorFileType.md) -### Classes +## Classes - [Generator](classes/Generator.md) -### Interfaces +## Interfaces - [GeneratorProps](interfaces/GeneratorProps.md) - [SerializerProps](interfaces/SerializerProps.md) diff --git a/docs/classes/Generator.md b/docs/classes/Generator.md index 5a6cd2e..207c7cd 100644 --- a/docs/classes/Generator.md +++ b/docs/classes/Generator.md @@ -1,69 +1,54 @@ +[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs** + +*** + [@time-loop/cdk-s3-file-generator](../README.md) / Generator # Class: Generator -## Hierarchy +## Extends - `BucketDeployment` - ↳ **`Generator`** - -## Table of contents - -### Constructors - -- [constructor](Generator.md#constructor) - -### Properties - -- [node](Generator.md#node) - -### Accessors +## Constructors -- [deployedBucket](Generator.md#deployedbucket) -- [objectKeys](Generator.md#objectkeys) +### new Generator() -### Methods +> **new Generator**(`scope`, `id`, `props`): [`Generator`](Generator.md) -- [addSource](Generator.md#addsource) -- [toString](Generator.md#tostring) -- [isConstruct](Generator.md#isconstruct) +#### Parameters -## Constructors +• **scope**: `Construct` -### constructor +• **id**: `string` -• **new Generator**(`scope`, `id`, `props`) +• **props**: [`GeneratorProps`](../interfaces/GeneratorProps.md) -#### Parameters +#### Returns -| Name | Type | -| :------ | :------ | -| `scope` | `Construct` | -| `id` | `string` | -| `props` | [`GeneratorProps`](../interfaces/GeneratorProps.md) | +[`Generator`](Generator.md) #### Overrides -BucketDeployment.constructor +`BucketDeployment.constructor` ## Properties ### node -• `Readonly` **node**: `Node` +> `readonly` **node**: `Node` The tree node. #### Inherited from -BucketDeployment.node +`BucketDeployment.node` ## Accessors ### deployedBucket -• `get` **deployedBucket**(): `IBucket` +> `get` **deployedBucket**(): `IBucket` The bucket after the deployment @@ -79,15 +64,11 @@ on the bucket deployment instead: `otherResource.node.addDependency(deployment)` `IBucket` -#### Inherited from - -BucketDeployment.deployedBucket - -___ +*** ### objectKeys -• `get` **objectKeys**(): `string`[] +> `get` **objectKeys**(): `string`[] The object keys for the sources deployed to the S3 bucket. @@ -104,29 +85,27 @@ first source file in your bucket deployment. `string`[] -#### Inherited from - -BucketDeployment.objectKeys - ## Methods -### addSource +### addSource() -▸ **addSource**(`source`): `void` +> **addSource**(`source`): `void` Add an additional source to the bucket deployment #### Parameters -| Name | Type | -| :------ | :------ | -| `source` | `ISource` | +• **source**: `ISource` #### Returns `void` -**`Example`** +#### Inherited from + +`BucketDeployment.addSource` + +#### Example ```ts declare const websiteBucket: s3.IBucket; @@ -138,15 +117,11 @@ const deployment = new s3deploy.BucketDeployment(this, 'Deployment', { deployment.addSource(s3deploy.Source.asset('./another-asset')); ``` -#### Inherited from - -BucketDeployment.addSource - -___ +*** -### toString +### toString() -▸ **toString**(): `string` +> **toString**(): `string` Returns a string representation of this construct. @@ -156,13 +131,13 @@ Returns a string representation of this construct. #### Inherited from -BucketDeployment.toString +`BucketDeployment.toString` -___ +*** -### isConstruct +### isConstruct() -▸ `Static` **isConstruct**(`x`): x is Construct +> `static` **isConstruct**(`x`): `x is Construct` Checks if `x` is a construct. @@ -182,16 +157,16 @@ this type-testing method instead. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `x` | `any` | Any object | +• **x**: `any` + +Any object #### Returns -x is Construct +`x is Construct` true if `x` is an object created from a class which extends `Construct`. #### Inherited from -BucketDeployment.isConstruct +`BucketDeployment.isConstruct` diff --git a/docs/enums/GeneratorFileType.md b/docs/enumerations/GeneratorFileType.md similarity index 54% rename from docs/enums/GeneratorFileType.md rename to docs/enumerations/GeneratorFileType.md index 54e98ea..82ba828 100644 --- a/docs/enums/GeneratorFileType.md +++ b/docs/enumerations/GeneratorFileType.md @@ -1,15 +1,13 @@ -[@time-loop/cdk-s3-file-generator](../README.md) / GeneratorFileType - -# Enumeration: GeneratorFileType +[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs** -## Table of contents +*** -### Enumeration Members +[@time-loop/cdk-s3-file-generator](../README.md) / GeneratorFileType -- [JSON](GeneratorFileType.md#json) +# Enumeration: GeneratorFileType ## Enumeration Members ### JSON -• **JSON** = ``"generator_json"`` +> **JSON**: `"generator_json"` diff --git a/docs/interfaces/GeneratorProps.md b/docs/interfaces/GeneratorProps.md index a7ecdc3..c60d1e7 100644 --- a/docs/interfaces/GeneratorProps.md +++ b/docs/interfaces/GeneratorProps.md @@ -1,215 +1,178 @@ +[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs** + +*** + [@time-loop/cdk-s3-file-generator](../README.md) / GeneratorProps # Interface: GeneratorProps -## Hierarchy - -- `Omit`<`BucketDeploymentProps`, ``"sources"``\> - - ↳ **`GeneratorProps`** - -## Table of contents - -### Properties - -- [accessControl](GeneratorProps.md#accesscontrol) -- [cacheControl](GeneratorProps.md#cachecontrol) -- [contentDisposition](GeneratorProps.md#contentdisposition) -- [contentEncoding](GeneratorProps.md#contentencoding) -- [contentLanguage](GeneratorProps.md#contentlanguage) -- [contentType](GeneratorProps.md#contenttype) -- [contents](GeneratorProps.md#contents) -- [destinationBucket](GeneratorProps.md#destinationbucket) -- [destinationKeyPrefix](GeneratorProps.md#destinationkeyprefix) -- [distribution](GeneratorProps.md#distribution) -- [distributionPaths](GeneratorProps.md#distributionpaths) -- [ephemeralStorageSize](GeneratorProps.md#ephemeralstoragesize) -- [exclude](GeneratorProps.md#exclude) -- [expires](GeneratorProps.md#expires) -- [extract](GeneratorProps.md#extract) -- [fileName](GeneratorProps.md#filename) -- [fileType](GeneratorProps.md#filetype) -- [include](GeneratorProps.md#include) -- [logRetention](GeneratorProps.md#logretention) -- [memoryLimit](GeneratorProps.md#memorylimit) -- [metadata](GeneratorProps.md#metadata) -- [prune](GeneratorProps.md#prune) -- [retainOnDelete](GeneratorProps.md#retainondelete) -- [role](GeneratorProps.md#role) -- [serializer](GeneratorProps.md#serializer) -- [serverSideEncryption](GeneratorProps.md#serversideencryption) -- [serverSideEncryptionAwsKmsKeyId](GeneratorProps.md#serversideencryptionawskmskeyid) -- [serverSideEncryptionCustomerAlgorithm](GeneratorProps.md#serversideencryptioncustomeralgorithm) -- [signContent](GeneratorProps.md#signcontent) -- [storageClass](GeneratorProps.md#storageclass) -- [useEfs](GeneratorProps.md#useefs) -- [vpc](GeneratorProps.md#vpc) -- [vpcSubnets](GeneratorProps.md#vpcsubnets) -- [websiteRedirectLocation](GeneratorProps.md#websiteredirectlocation) +## Extends + +- `Omit`\<`BucketDeploymentProps`, `"sources"`\> ## Properties -### accessControl +### accessControl? -• `Optional` `Readonly` **accessControl**: `BucketAccessControl` +> `optional` `readonly` **accessControl**: `BucketAccessControl` System-defined x-amz-acl metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl #### Inherited from -Omit.accessControl +`Omit.accessControl` -___ +*** -### cacheControl +### cacheControl? -• `Optional` `Readonly` **cacheControl**: `CacheControl`[] +> `optional` `readonly` **cacheControl**: `CacheControl`[] System-defined cache-control metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.cacheControl +`Omit.cacheControl` -___ +*** -### contentDisposition +### contentDisposition? -• `Optional` `Readonly` **contentDisposition**: `string` +> `optional` `readonly` **contentDisposition**: `string` System-defined cache-disposition metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.contentDisposition +`Omit.contentDisposition` -___ +*** -### contentEncoding +### contentEncoding? -• `Optional` `Readonly` **contentEncoding**: `string` +> `optional` `readonly` **contentEncoding**: `string` System-defined content-encoding metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.contentEncoding +`Omit.contentEncoding` -___ +*** -### contentLanguage +### contentLanguage? -• `Optional` `Readonly` **contentLanguage**: `string` +> `optional` `readonly` **contentLanguage**: `string` System-defined content-language metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.contentLanguage +`Omit.contentLanguage` -___ +*** -### contentType +### contentType? -• `Optional` `Readonly` **contentType**: `string` +> `optional` `readonly` **contentType**: `string` System-defined content-type metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.contentType +`Omit.contentType` -___ +*** ### contents -• `Readonly` **contents**: `any` +> `readonly` **contents**: `any` The data to be marshalled. -___ +*** ### destinationBucket -• `Readonly` **destinationBucket**: `IBucket` +> `readonly` **destinationBucket**: `IBucket` The S3 bucket to sync the contents of the zip file to. #### Inherited from -Omit.destinationBucket +`Omit.destinationBucket` -___ +*** -### destinationKeyPrefix +### destinationKeyPrefix? -• `Optional` `Readonly` **destinationKeyPrefix**: `string` +> `optional` `readonly` **destinationKeyPrefix**: `string` Key prefix in the destination bucket. Must be <=104 characters -**`Default`** +#### Default ```ts "/" (unzip to root of the destination bucket) @@ -217,19 +180,19 @@ Must be <=104 characters #### Inherited from -Omit.destinationKeyPrefix +`Omit.destinationKeyPrefix` -___ +*** -### distribution +### distribution? -• `Optional` `Readonly` **distribution**: `IDistribution` +> `optional` `readonly` **distribution**: `IDistribution` The CloudFront distribution using the destination bucket as an origin. Files in the distribution's edge caches will be invalidated after files are uploaded to the destination bucket. -**`Default`** +#### Default ```ts - No invalidation occurs @@ -237,17 +200,17 @@ files are uploaded to the destination bucket. #### Inherited from -Omit.distribution +`Omit.distribution` -___ +*** -### distributionPaths +### distributionPaths? -• `Optional` `Readonly` **distributionPaths**: `string`[] +> `optional` `readonly` **distributionPaths**: `string`[] The file paths to invalidate in the CloudFront distribution. -**`Default`** +#### Default ```ts - All files under the destination bucket key prefix will be invalidated. @@ -255,17 +218,17 @@ The file paths to invalidate in the CloudFront distribution. #### Inherited from -Omit.distributionPaths +`Omit.distributionPaths` -___ +*** -### ephemeralStorageSize +### ephemeralStorageSize? -• `Optional` `Readonly` **ephemeralStorageSize**: `Size` +> `optional` `readonly` **ephemeralStorageSize**: `Size` The size of the AWS Lambda function’s /tmp directory in MiB. -**`Default`** +#### Default ```ts 512 MiB @@ -273,13 +236,13 @@ The size of the AWS Lambda function’s /tmp directory in MiB. #### Inherited from -Omit.ephemeralStorageSize +`Omit.ephemeralStorageSize` -___ +*** -### exclude +### exclude? -• `Optional` `Readonly` **exclude**: `string`[] +> `optional` `readonly` **exclude**: `string`[] If this is set, matching files or objects will be excluded from the deployment's sync command. This can be used to exclude a file from being pruned in the destination bucket. @@ -288,52 +251,52 @@ If you want to just exclude files from the deployment package (which excludes th evaluated when invalidating the asset), you should leverage the `exclude` property of `AssetOptions` when defining your source. -**`Default`** +#### Default ```ts - No exclude filters are used ``` -**`See`** +#### See https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters #### Inherited from -Omit.exclude +`Omit.exclude` -___ +*** -### expires +### expires? -• `Optional` `Readonly` **expires**: `Expiration` +> `optional` `readonly` **expires**: `Expiration` System-defined expires metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - The objects in the distribution will not expire. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.expires +`Omit.expires` -___ +*** -### extract +### extract? -• `Optional` `Readonly` **extract**: `boolean` +> `optional` `readonly` **extract**: `boolean` If this is set, the zip file will be synced to the destination S3 bucket and extracted. If false, the file will remain zipped in the destination bucket. -**`Default`** +#### Default ```ts true @@ -341,55 +304,55 @@ true #### Inherited from -Omit.extract +`Omit.extract` -___ +*** ### fileName -• `Readonly` **fileName**: `string` +> `readonly` **fileName**: `string` Name of the file, to be created in the path. -___ +*** ### fileType -• `Readonly` **fileType**: [`JSON`](../enums/GeneratorFileType.md#json) +> `readonly` **fileType**: [`JSON`](../enumerations/GeneratorFileType.md#json) -___ +*** -### include +### include? -• `Optional` `Readonly` **include**: `string`[] +> `optional` `readonly` **include**: `string`[] If this is set, matching files or objects will be included with the deployment's sync command. Since all files from the deployment package are included by default, this property is usually leveraged alongside an `exclude` filter. -**`Default`** +#### Default ```ts - No include filters are used and all files are included with the sync command ``` -**`See`** +#### See https://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters #### Inherited from -Omit.include +`Omit.include` -___ +*** -### logRetention +### logRetention? -• `Optional` `Readonly` **logRetention**: `RetentionDays` +> `optional` `readonly` **logRetention**: `RetentionDays` The number of days that the lambda function's log events are kept in CloudWatch Logs. -**`Default`** +#### Default ```ts logs.RetentionDays.INFINITE @@ -397,13 +360,13 @@ logs.RetentionDays.INFINITE #### Inherited from -Omit.logRetention +`Omit.logRetention` -___ +*** -### memoryLimit +### memoryLimit? -• `Optional` `Readonly` **memoryLimit**: `number` +> `optional` `readonly` **memoryLimit**: `number` The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket. @@ -411,7 +374,7 @@ replicates the files from the CDK bucket to the destination bucket. If you are deploying large files, you will need to increase this number accordingly. -**`Default`** +#### Default ```ts 128 @@ -419,48 +382,48 @@ accordingly. #### Inherited from -Omit.memoryLimit +`Omit.memoryLimit` -___ +*** -### metadata +### metadata? -• `Optional` `Readonly` **metadata**: `Object` +> `optional` `readonly` **metadata**: `object` User-defined object metadata to be set on all objects in the deployment -**`Default`** +#### Default ```ts - No user metadata is set ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#UserMetadata #### Index signature -▪ [key: `string`]: `string` + \[`key`: `string`\]: `string` #### Inherited from -Omit.metadata +`Omit.metadata` -___ +*** -### prune +### prune? -• `Optional` `Readonly` **prune**: `boolean` +> `optional` `readonly` **prune**: `boolean` 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). -**`See`** +#### See https://docs.aws.amazon.com/cli/latest/reference/s3/sync.html -**`Default`** +#### Default ```ts true @@ -468,13 +431,13 @@ true #### Inherited from -Omit.prune +`Omit.prune` -___ +*** -### retainOnDelete +### retainOnDelete? -• `Optional` `Readonly` **retainOnDelete**: `boolean` +> `optional` `readonly` **retainOnDelete**: `boolean` If this is set to "false", the destination files will be deleted when the resource is deleted or the destination is updated. @@ -482,11 +445,11 @@ resource is deleted or the destination is updated. NOTICE: Configuring this to "false" might have operational implications. Please visit to the package documentation referred below to make sure you fully understand those implications. -**`See`** +#### See https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment#retain-on-delete -**`Default`** +#### Default ```ts true - when resource is deleted/updated, files are retained @@ -494,17 +457,17 @@ true - when resource is deleted/updated, files are retained #### Inherited from -Omit.retainOnDelete +`Omit.retainOnDelete` -___ +*** -### role +### role? -• `Optional` `Readonly` **role**: `IRole` +> `optional` `readonly` **role**: `IRole` Execution role associated with this function -**`Default`** +#### Default ```ts - A role is automatically created @@ -512,132 +475,132 @@ Execution role associated with this function #### Inherited from -Omit.role +`Omit.role` -___ +*** -### serializer +### serializer? -• `Optional` `Readonly` **serializer**: [`SerializerProps`](SerializerProps.md) +> `optional` `readonly` **serializer**: [`SerializerProps`](SerializerProps.md) Optionally define how to serialize the final output. -___ +*** -### serverSideEncryption +### serverSideEncryption? -• `Optional` `Readonly` **serverSideEncryption**: `ServerSideEncryption` +> `optional` `readonly` **serverSideEncryption**: `ServerSideEncryption` System-defined x-amz-server-side-encryption metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Server side encryption is not used. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.serverSideEncryption +`Omit.serverSideEncryption` -___ +*** -### serverSideEncryptionAwsKmsKeyId +### serverSideEncryptionAwsKmsKeyId? -• `Optional` `Readonly` **serverSideEncryptionAwsKmsKeyId**: `string` +> `optional` `readonly` **serverSideEncryptionAwsKmsKeyId**: `string` System-defined x-amz-server-side-encryption-aws-kms-key-id metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.serverSideEncryptionAwsKmsKeyId +`Omit.serverSideEncryptionAwsKmsKeyId` -___ +*** -### serverSideEncryptionCustomerAlgorithm +### serverSideEncryptionCustomerAlgorithm? -• `Optional` `Readonly` **serverSideEncryptionCustomerAlgorithm**: `string` +> `optional` `readonly` **serverSideEncryptionCustomerAlgorithm**: `string` System-defined x-amz-server-side-encryption-customer-algorithm metadata to be set on all objects in the deployment. Warning: This is not a useful parameter until this bug is fixed: https://github.com/aws/aws-cdk/issues/6080 -**`Default`** +#### Default ```ts - Not set. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html#sse-c-how-to-programmatically-intro #### Inherited from -Omit.serverSideEncryptionCustomerAlgorithm +`Omit.serverSideEncryptionCustomerAlgorithm` -___ +*** -### signContent +### signContent? -• `Optional` `Readonly` **signContent**: `boolean` +> `optional` `readonly` **signContent**: `boolean` If set to true, uploads will precompute the value of `x-amz-content-sha256` and include it in the signed S3 request headers. -**`Default`** +#### Default - `x-amz-content-sha256` will not be computed #### Inherited from -Omit.signContent +`Omit.signContent` -___ +*** -### storageClass +### storageClass? -• `Optional` `Readonly` **storageClass**: `StorageClass` +> `optional` `readonly` **storageClass**: `StorageClass` System-defined x-amz-storage-class metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - Default storage-class for the bucket is used. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.storageClass +`Omit.storageClass` -___ +*** -### useEfs +### useEfs? -• `Optional` `Readonly` **useEfs**: `boolean` +> `optional` `readonly` **useEfs**: `boolean` Mount an EFS file system. Enable this if your assets are large and you encounter disk space errors. Enabling this option will require a VPC to be specified. -**`Default`** +#### Default ```ts - No EFS. Lambda has access only to 512MB of disk space. @@ -645,18 +608,18 @@ Mount an EFS file system. Enable this if your assets are large and you encounter #### Inherited from -Omit.useEfs +`Omit.useEfs` -___ +*** -### vpc +### vpc? -• `Optional` `Readonly` **vpc**: `IVpc` +> `optional` `readonly` **vpc**: `IVpc` The VPC network to place the deployment lambda handler in. This is required if `useEfs` is set. -**`Default`** +#### Default ```ts None @@ -664,18 +627,18 @@ None #### Inherited from -Omit.vpc +`Omit.vpc` -___ +*** -### vpcSubnets +### vpcSubnets? -• `Optional` `Readonly` **vpcSubnets**: `SubnetSelection` +> `optional` `readonly` **vpcSubnets**: `SubnetSelection` Where in the VPC to place the deployment lambda handler. Only used if 'vpc' is supplied. -**`Default`** +#### Default ```ts - the Vpc default strategy if not specified @@ -683,26 +646,26 @@ Only used if 'vpc' is supplied. #### Inherited from -Omit.vpcSubnets +`Omit.vpcSubnets` -___ +*** -### websiteRedirectLocation +### websiteRedirectLocation? -• `Optional` `Readonly` **websiteRedirectLocation**: `string` +> `optional` `readonly` **websiteRedirectLocation**: `string` System-defined x-amz-website-redirect-location metadata to be set on all objects in the deployment. -**`Default`** +#### Default ```ts - No website redirection. ``` -**`See`** +#### See https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#SysMetadata #### Inherited from -Omit.websiteRedirectLocation +`Omit.websiteRedirectLocation` diff --git a/docs/interfaces/SerializerProps.md b/docs/interfaces/SerializerProps.md index eeafdc2..63ef32a 100644 --- a/docs/interfaces/SerializerProps.md +++ b/docs/interfaces/SerializerProps.md @@ -1,22 +1,20 @@ -[@time-loop/cdk-s3-file-generator](../README.md) / SerializerProps - -# Interface: SerializerProps +[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs** -## Table of contents +*** -### Properties +[@time-loop/cdk-s3-file-generator](../README.md) / SerializerProps -- [schema](SerializerProps.md#schema) +# Interface: SerializerProps ## Properties -### schema +### schema? -• `Optional` `Readonly` **schema**: `SchemaObject` +> `optional` `readonly` **schema**: `SchemaObject` Skeleton of final structure, i.e., definition of the output's structure. -**`Default`** +#### Default ```ts - no schema defined, file can be unstructured diff --git a/docs/interfaces/UploadProps.md b/docs/interfaces/UploadProps.md index 33b2047..9902b9c 100644 --- a/docs/interfaces/UploadProps.md +++ b/docs/interfaces/UploadProps.md @@ -1,67 +1,60 @@ -[@time-loop/cdk-s3-file-generator](../README.md) / UploadProps - -# Interface: UploadProps +[**@time-loop/cdk-s3-file-generator**](../README.md) • **Docs** -## Table of contents +*** -### Properties +[@time-loop/cdk-s3-file-generator](../README.md) / UploadProps -- [bucket](UploadProps.md#bucket) -- [fileName](UploadProps.md#filename) -- [path](UploadProps.md#path) -- [prune](UploadProps.md#prune) -- [retainOnDelete](UploadProps.md#retainondelete) -- [role](UploadProps.md#role) +# Interface: UploadProps ## Properties ### bucket -• `Readonly` **bucket**: `IBucket` +> `readonly` **bucket**: `IBucket` Bucket where the file will be uploaded. -___ +*** ### fileName -• `Readonly` **fileName**: `string` +> `readonly` **fileName**: `string` Name of the file, to be created in the path. -___ +*** -### path +### path? -• `Optional` `Readonly` **path**: `string` +> `optional` `readonly` **path**: `string` The path in the bucket to which the file will be uploaded. -**`Default`** +#### Default ```ts - root of the bucket ``` -___ +*** -### prune +### prune? -• `Optional` `Readonly` **prune**: `boolean` +> `optional` `readonly` **prune**: `boolean` Whether or not to clear out the destination directory before uploading. -**`Default`** +#### Default ```ts false ``` -___ +*** -### retainOnDelete +### retainOnDelete? -• `Optional` `Readonly` **retainOnDelete**: `boolean` +> `optional` `readonly` **retainOnDelete**: `boolean` Whether or not to delete the objects from the bucket when this resource is deleted/updated from the stack. @@ -72,21 +65,21 @@ This is because CloudFormation will first create the new resource, which will ha followed by a deletion of the old resource, which will cause a deletion of the objects, since the destination hasn't changed, and `retainOnDelete` is `false`. -**`Default`** +#### Default ```ts true ``` -___ +*** -### role +### role? -• `Optional` `Readonly` **role**: `IRole` +> `optional` `readonly` **role**: `IRole` Used as the Lambda Execution Role for the BucketDeployment. -**`Default`** +#### Default ```ts - role is created automatically by the Construct