UNPKG

@webda/aws

Version:

Webda AWS Services implementation

429 lines 12.8 kB
{ "beans": {}, "deployers": { "WebdaAWSDeployer/CloudFormation": "lib/deployers/cloudformation:default", "WebdaAWSDeployer/LambdaPackager": "lib/deployers/lambdapackager:default" }, "moddas": { "Webda/AWSSecretsManager": "lib/services/secretsmanager:default", "Webda/CloudWatchLogger": "lib/services/cloudwatchlogger:default", "Webda/DynamoStore": "lib/services/dynamodb:default", "Webda/LambdaCaller": "lib/services/lambdacaller:LambdaCaller", "Webda/S3Binary": "lib/services/s3binary:default", "Webda/SQSQueue": "lib/services/sqsqueue:default" }, "models": { "graph": {}, "tree": {}, "plurals": {}, "list": {}, "reflections": {} }, "schemas": { "Webda/AWSSecretsManager": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "type" ], "description": "Interface to specify the Service parameters", "$schema": "http://json-schema.org/draft-07/schema#", "title": "CloudWatchLogger" }, "Webda/BinaryFile": { "type": "object", "properties": { "hash": { "type": "string", "description": "Will be computed by the service\n\nhash of the content" }, "challenge": { "type": "string", "description": "Will be computed by the service\n\nhash of the content prefixed by 'WEBDA'" }, "size": { "type": "number", "description": "Size of the binary" }, "name": { "type": "string", "description": "Current name" }, "mimetype": { "type": "string", "description": "Mimetype of the binary" }, "metadata": { "description": "Metadatas stored along with the binary" }, "originalname": { "type": "string", "description": "Original name" } }, "required": [ "mimetype", "name", "size" ], "description": "Represent a file to store", "$schema": "http://json-schema.org/draft-07/schema#", "title": "BinaryFile" }, "Webda/CloudWatchLogger": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "type" ], "description": "Interface to specify the Service parameters", "$schema": "http://json-schema.org/draft-07/schema#", "title": "CloudWatchLogger" }, "Webda/DynamoStore": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "model": { "type": "string", "description": "Webda model to use within the Store", "default": "Webda/CoreModel" }, "additionalModels": { "type": "array", "items": { "type": "string" }, "description": "Additional models\n\nAllow this store to manage other models", "default": [] }, "asyncDelete": { "type": "boolean", "description": "async delete" }, "expose": { "$ref": "#/definitions/StoreExposeParameters", "description": "Expose the service to an urls", "deprecated": "will probably be removed in 4.0 in favor of Expose annotation" }, "strict": { "type": "boolean", "description": "Allow to load object that does not have the type data\n\nIf set to true, then the Store will only managed the defined _model and no model extending this one", "default": false }, "defaultModel": { "type": "boolean", "description": "When __type model not found, use the model If strict is setup this parameter is not used", "default": true }, "forceModel": { "type": "boolean", "description": "If set, Store will ignore the __type", "default": false }, "slowQueryThreshold": { "type": "number", "description": "Slow query threshold", "default": 30000 }, "modelAliases": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Model Aliases to allow easier rename of Model" }, "noCache": { "type": "boolean", "description": "Disable default memory cache" }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "asyncDelete", "slowQueryThreshold", "type" ], "description": "Store parameter", "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "StoreExposeParameters": { "type": "object", "properties": { "url": { "type": "string", "description": "URL endpoint to use to expose REST Resources API", "default": "service.getName().toLowerCase()" }, "restrict": { "type": "object", "properties": { "create": { "type": "boolean", "description": "Do not expose the POST" }, "update": { "type": "boolean", "description": "Do not expose the PUT and PATCH" }, "get": { "type": "boolean", "description": "Do not expose the GET" }, "delete": { "type": "boolean", "description": "Do not expose the DELETE" }, "query": { "type": "boolean", "description": "Do not expose the query endpoint" } }, "description": "You can restrict any part of the CRUD", "default": {} }, "queryMethod": { "type": "string", "enum": [ "PUT", "GET" ], "description": "For confidentiality sometimes you might prefer to expose query through PUT To avoid GET logging", "default": "GET" } }, "deprecated": "Store should not be exposed directly anymore\nYou should use the DomainService instead" } }, "title": "DynamoStore" }, "Webda/LambdaCaller": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "actions": { "type": "array", "items": { "type": "string" }, "description": "Actions managed by the runner", "default": [] }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "type" ], "$schema": "http://json-schema.org/draft-07/schema#", "title": "LambdaCaller" }, "Webda/S3Binary": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "map": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Define the map to Object collection\n\nkey is a Store name the string[] represent all valids attributes to store files in", "deprecated": true }, "models": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Define the map of models\n* indicates all models\n\nkey is a Store name the string[] represent all valids attributes to store files in * indicates all attributes" }, "expose": { "type": "object", "properties": { "url": { "type": "string", "description": "URL to expose the service to" }, "restrict": { "type": "object", "properties": { "get": { "type": "boolean", "description": "Restrict GET" }, "create": { "type": "boolean", "description": "Restrict POST" }, "delete": { "type": "boolean", "description": "Restrict DELETE" }, "metadata": { "type": "boolean", "description": "Restrict update of metadata" } }, "description": "Restrict some APIs" } }, "required": [ "url" ], "description": "Expose the service to http", "deprecated": "will be removed in 4.0" }, "prefix": { "type": "string" }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "map", "models", "type" ], "description": "Default binary parameters", "$schema": "http://json-schema.org/draft-07/schema#", "title": "S3Binary" }, "Webda/SQSQueue": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the service" }, "url": { "type": "string", "description": "URL on which to serve the content" }, "workerDelayer": { "type": "object", "properties": { "interval": { "type": "number", "description": "Interval" }, "type": { "type": "string", "description": "Type of delayer registered in WaitDelayerFactoryRegistry" } }, "required": [ "interval", "type" ], "description": "Delayer between two failed attempts to process messages" }, "workerParallelism": { "type": "boolean", "description": "Define if worker should process multi message received in //", "default": true }, "maxConsumers": { "type": "number", "description": "Max number of queue consumers Queue will auto increase to this max number if queue is loaded and it will decrease to just one consumer if no messages are available", "default": 10 }, "openapi": { "type": "object", "additionalProperties": true } }, "required": [ "maxConsumers", "type" ], "$schema": "http://json-schema.org/draft-07/schema#", "title": "SQSQueue" }, "WebdaAWSDeployer/CloudFormation": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "$schema": "http://json-schema.org/draft-07/schema#", "title": "LambdaPackager" }, "WebdaAWSDeployer/LambdaPackager": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "$schema": "http://json-schema.org/draft-07/schema#", "title": "LambdaPackager" } } }