diff --git a/hamlet/s3support/README.md b/hamlet/s3support/README.md index c64e8b9..7822837 100644 --- a/hamlet/s3support/README.md +++ b/hamlet/s3support/README.md @@ -38,63 +38,102 @@ Basic setup of the module: ```json { - "Modules" : { - "s3Copy" : { - "Provider" : "s3support", - "Name" : "s3_inventory_copy", - "Enabled" : true, - "Parameters" : { - "id" : { - "Key" : "id", - "Value" : "" + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "$id": "https://hamlet.io/schema/latest/blueprint/module-s3_inventory_copy-schema.json", + "definitions": { + "s3_inventory_copy": { + "type": "object", + "patternProperties": { + "^[A-Za-z_][A-Za-z0-9_]*$": { + "properties": { + "id": { + "type": "string", + "description": "A unique id for this instance of the api" }, - "tier" : { - "Key" : "tier", - "Value" : "" + "tier": { + "type": "string", + "description": "The tier the components will belong to" }, - "moveObjects" : { - "Key" : "moveObjects", - "Value" : "< boolean - Once the file has been copied removed the original" + "instance": { + "type": "string", + "description": "The instance id of the components", + "default": "default" }, - "s3KeyPrefix" : { - "Key" : "s3KeyPrefix", - "Value" : { - "Enabled" : "", - "Path" : "< instance of contextpath attribute set>" + "moveObjects": { + "type": "boolean", + "description": "Once the file has been copied removed the original", + "default": false + }, + "s3KeyPrefix": { + "type": "object", + "additionalProperties": false, + "description": "Creates a key prefix based on the deployment context", + "properties": { + "Enabled": { + "type": "boolean", + "default": true + }, + "Path": { + "$ref": "https://hamlet.io/schema/latest/blueprint/schema-attributeset-schema.json#/contextpath" } + } }, - "s3KeySuffix" : { - "Key" : "s3KeySuffix", - "Value" : { - "Enabled" : "", - "Path" : "< instance of contextpath attribute set>" + "s3KeySuffix": { + "type": "object", + "additionalProperties": false, + "description": "Creates a key suffix based on the deployment context", + "properties": { + "Enabled": { + "type": "boolean", + "default": false + }, + "Path": { + "$ref": "https://hamlet.io/schema/latest/blueprint/schema-attributeset-schema.json#/contextpath" } + } + }, + "s3InventoryPrefix": { + "type": "string", + "description": "The prefix to use for inventory generation on the source bucket", + "default": "s3_inventory_copy/" }, - "sourceBucket" : { - "Key" : "sourceBucketLink", - "Value" : "" + "s3InventoryProfileSuffix": { + "type": "string", + "description": "The suffix ( added to the id ) for the deployment profile which configures the userpool client", + "default": "_s3inventorycopy" }, - "lambdaImageUrl" : { - "Key" : "lambdaImageUrl", - "Value" : "" + "lambdaImageUrl": { + "type": "string", + "description": "The url to the lambda zip image", + "default": "https://github.com/hamlet-io/lambda-s3-support/releases/download/v0.0.12/s3-inventory-copy.zip" }, - "lambdaImageHash" : { - "Key" : "lambdaImageHash", - "Value" : "" + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "$id": "https://hamlet.io/schema/latest/blueprint/module-s3_age_metric-schema.json", + "definitions": { + "s3_age_metric": { + "type": "object", + "patternProperties": { + "^[A-Za-z_][A-Za-z0-9_]*$": { + "properties": { + "id": { + "type": "string", + "description": "A unique id for this instance of the api" }, - "tier" : { - "Key" : "tier", - "Value" : "" + "tier": { + "type": "string", + "description": "The tier the components will belong to" }, - "instance" : { - "Key" : "instance", - "Value" : "" + "instance": { + "type": "string", + "description": "The instance id of the components", + "default": "default" }, - "bucketLink" : { - "Key" : "bucketLink", - "Value" : "" + "lambdaImageUrl": { + "type": "string", + "description": "The url to the lambda zip image", + "default": "https://github.com/hamlet-io/lambda-s3-support/releases/download/v0.0.12/s3-age-metric.zip" }, - "lambdaImageHash" : { - "Key" : "lambdaImageHash", - "Value" : "