diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index efb4f26..d78fbc7 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA33MywrCMBCF4XeZdVFaUKQPoFtBuxIXQzvS4DQJkxG84Ltb3DQ1tevzn+/0AqW7Qgk7siSoTraG6fjwBBl41LafyN66sEyCRasd99XV2AbKzTtLrcGoGUOgSBm/82Lyvxfnw4AYqyQXrGPnm4yxYrWOsAOJQTZPmtF+mjmu8uyw+U9Fe8qcP5Wwh1VwAQAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4uuVipJrShRslJyT81LLUosyS9yy8xJDaksSFXSUSpILMkASqXmleYW62Mo0Msoyc0BqsrOzEtRsrKo1cE0C2FGck5icXEqkimoug2NkPWDbAgoyi8oRujPzCtJLUpLTAYaAZdFNcLI1AybE3Cbg6oEn2HBqUWZiTmZVal4TENTg2lcLABbmhuxbAEAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index ca65dd6..31b0b02 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6VWTY/aMBD9L+YaAeMQCJyrVu1ht9K2vSBUpeAt6YYkckK/EP+94yTE48XeeOkF4eS9eZ43HmdOTBa/KrZan9hTmu/YKg5YnhwEW7F3IhcyqQv5Ns3Epz+lYAE7ygzfiPx4qCZX78f7+pAhaJslVSUwKGPn4BIX5n3gDw/3d16xRh2SBAxYmUiR19b9aTUeabnPZVYku4+yKKteNc1rIR+Tragm5PXLCUz5rI/57bh9ErVPuFEPtWdBd+cQK5N67yXVAW8WekQj79RfHzECvj0zecz91C7Im6WkqJM0v8/fiEzUfppXlNvFi8xTsgW+Roge9Qch0yRL/wrpPO7PIP5HvtruxSHxDTnq4fZcnu/Unk/f4s50TIR/NtsCY+S1b8wRwQ/cRoMdZlylA7IE/7+yrsZ2yb7Y236yVV9kX2GD8Vppbvl29cJdMK364lmJgNOjUtXyuB2ONjKhA/tn502AfuzEb7Y6sZ9CVmmRI4CPw/ESGY+pyHbq09xuBOMVh4OKsenefRFKSCFayGTKgvU04NE4XG42wfpCaJ43DxoU4AosKDBQHFfcguIGKsRVaEGFBmqGq5kFNTNQEa6igE/HPAYDFhmwOa7mlmBzA7XA1cKCWhioGFexBRUbKCzGemlBLU1blctgsx+e+d8UwFoBswSgvAZbEcCsAii7wVYHMAsBM5fHYNYClOdgqxmY1QBlO0Q2oFkQUM6DrXDQ1qRpBuyCWuzet02Bx/oyPJ3Y165TwktfnliIP+ez7gu1agOTLtRMPYGeGGo6ud09T4icELmDqK7Mtk81MdK8SAEDhja76XVz0RNdkiu4kv2ubzrCJMpYhwGmTXuqA0yH+GX7cSbyQOTBQf9R4W1HSYTjoLTzrabMNMXlazc3ag45BC5j2rmvQHw792nyQpNdB6id4DQl1pTYQbmMSsQLYj+4/KffSkIlpkA0SL2q3VLTlw72sZlDr5ikS6xNgg1epqXIUizIar05n/8Brc4hHnwOAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WWyW7bMBCG34W6Crap3XqAFu0hLZCiF8EoBJtulGgDKXcT9O4dSraGtKkF7c1jfv8snN9MWsKrn4LESUvesvJE4sgmZVowEpP3rGQ8bSr+LsvZl981Iza58BxOWHkpxPbhfPPSFDlAxzwVgkFSQjr7lpcGY+KPz5+eVuWyrqSS0CZ1ylnZGPvDao6P5Z4Zz9I8+8P4Z17VYqyclQ3j5/TIxPYOmR9k53hjbnF8YUW6NqU14uaJ7js1zyPHnZxkPFw/w7ECedmsSGcpqHkC7G2i2BmAJ/lxuZiC/kcxzbjzxa7oPxYT4/JWlNPg9QVVG4z2n/SCTqw3hLyLtQmtG7zwG324Osfw0Iw1r8mw4GzzPnVUM4uGX47L2SwdXeifdAcbruLEfpG4JT8YF1lVAuBs3M0eFOeM5Sf5jg6NQL6qKGSOw/XsK5OFJDEg2x2xk53tQAI3OBzs5KboD/oveoxCRE0Y1TAHIseEORrmQuSaMFfDPIg8E+ZpmA+Rb8J8DQsgCkxYoGEhRKEJCzUsgigyYZGGwVKSvQnb69crb5sa90DvFtFvwrwKfRdU3jk1boMO6+i9BCZq2OnD4Kkk0a3bkm9Xt6G5WwLyuO06dJeMhvy3hxmFPur8CZn88Q5+RVmAsmBGVg+vDuo81HkzOk0DF4+z7WZUTf80ozBEXTgh+46vilKQKgXpktJUWel4quFR/3BHexTvJ8SvAt4VtWOl4QnJ7b8KFLkocqdEyl8gFEYojBaFD+MpTjUaFWxfZzXLsxKY5NB1fwHxGRJbfgoAAA=="; \ No newline at end of file diff --git a/docs/classes/Generator.html b/docs/classes/Generator.html index d4bb11b..29c423f 100644 --- a/docs/classes/Generator.html +++ b/docs/classes/Generator.html @@ -198,9 +198,9 @@

  • GeneratorFileType
  • Generator
    • +
  • FileProps
  • GeneratorProps
    • -
  • SerializerProps
    • -
  • UploadProps
    • +
  • SerializerProps

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/GeneratorFileType.html b/docs/enums/GeneratorFileType.html index 8656004..a1d3d16 100644 --- a/docs/enums/GeneratorFileType.html +++ b/docs/enums/GeneratorFileType.html @@ -54,9 +54,9 @@

  • GeneratorFileType
  • Generator
    • +
  • FileProps
  • GeneratorProps
    • -
  • SerializerProps
    • -
  • UploadProps
    • +
  • SerializerProps

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 88bcd4c..f4be21d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,9 +25,9 @@

    Classes

    Interfaces

    -
    GeneratorProps +
    FileProps +GeneratorProps SerializerProps -UploadProps
    @@ -49,9 +49,9 @@

    Theme

    @@ -13,12 +13,12 @@
    -

    Interface UploadProps

    +
  • FileProps
    • +

    Interface FileProps

    Hierarchy

    +
  • FileProps
    • @@ -26,19 +26,17 @@

    Properties

    -
    -

    Readonly bucket

    -
    bucket: IBucket
    -

    Bucket where the file will be uploaded.

    +
    +

    Readonly contents

    +
    contents: any
    +

    The data to be marshalled.

    @@ -47,48 +45,15 @@

    Readonly

    Name of the file, to be created in the path.

    -
    -

    Optional Readonly path

    -
    path?: string
    -

    The path in the bucket to which the file will be uploaded.

    +
    +

    Optional Readonly fileType

    +
    fileType?: JSON
    +
    +

    Optional Readonly serializer

    +
    serializer?: SerializerProps
    +

    Optionally define how to serialize the final output.

    -
    -

    Default

    - root of the bucket
-
    -
    -
    -

    Optional Readonly prune

    -
    prune?: boolean
    -

    Whether or not to clear out the destination directory before uploading.

    -
    -
    -

    Default

    false
-
    -
    -
    -

    Optional Readonly retainOnDelete

    -
    retainOnDelete?: boolean
    -

    Whether or not to delete the objects from the bucket when this resource -is deleted/updated from the stack.

    -

    NOTE: Changing the logical ID of the BucketDeployment construct, without changing the destination -(for example due to refactoring, or intentional ID change) will result in the deletion of the objects. -This is because CloudFormation will first create the new resource, which will have no affect, -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

    true
-
    -
    -
    -

    Optional Readonly role

    -
    role?: IRole
    -

    Used as the Lambda Execution Role for the BucketDeployment.

    -
    -
    -

    Default

    - role is created automatically by the Construct
-
    -
    +
    @@ -108,20 +73,18 @@

    Theme