AWS S3 Resource
The AWS S3 Resource provides a way to connect to AWS S3-compatible APIs (opens in a new tab) directly from Dynaboard.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
AWS Access Key ID
| Prop | profiles[].accessKeyId |
|---|---|
| Type | string |
| Default | undefined |
The AWS Access Key ID to connect to the AWS API using.
AWS Secret Access Key
| Prop | profiles[].secretAccessKey |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
The AWS Secret Access Key to connect to the AWS API using.
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
List Buckets
Lists all buckets accessible to the current API key.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
Get Bucket Location
Gets the bucket location.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
name | string | undefined |
Create Bucket
Creates a new bucket in AWS S3.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
name | string | undefined |
Delete Bucket
Deletes a bucket from AWS S3.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
name | string | undefined |
List Objects
Retrieves a list of objects in the AWS S3 bucket.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
bucket | string | undefined |
startAfter | string | undefined |
maxKeys | string | undefined |
prefix | string | undefined |
continuationToken | string | undefined |
Delete Object
Deletes an object in the AWS S3 bucket.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
bucket | string | undefined |
key | string | undefined |
versionId | string | undefined |
Get Presigned URL
Get the presigned URL to download an object in an AWS S3 bucket.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
bucket | string | undefined |
key | string | undefined |
versionId | string | undefined |
Put Presigned URL
Gets the presigned URL to upload an object to an AWS S3 bucket.
| Parameter | Type | Default |
|---|---|---|
region | string | undefined |
bucket | string | undefined |
key | string | undefined |