apiopenstudio / transport_s3
Transport S3 for ApiOpenStudio output.
v1.0.0-BETA
2022-06-21 05:10 UTC
Requires
This package is auto-updated.
Last update: 2024-09-22 01:51:36 UTC
README
Transport for ApiOpenStudio output to an AWS S3 bucket
Adding to your project
Composer
$ composer require apiopenstudio/transport_s3
Configuration
Add a remote output processor to your resource.
The output section example below will return the output in the response as well as upload the response to an S3 bucket:
output:
-
processor: xml_remote
id: example XML Remote output
filename: example.xml
transport: ApiOpenStudio\Plugins\TransportS3
parameters:
key: my_aws_s3_bucket_key
secret: my_aws_s3_bucket_secret
bucket: my_bucket_name
version: version
region: my_bucket_region (optional)
-
response
Note: the value for the transport is the full namespace path.
Parameters
Required
- key - AWS S3 key
- secret - AWS S3 secret
- bucket - AWS S3 bucket name
- version - latest|version
Optional
- region - AWS S3 bucket region
Further information
See FlySystem documentation and The League GitHub for more details.