mirror of https://github.com/dapr/docs.git
2.3 KiB
2.3 KiB
type | title | linkTitle | description |
---|---|---|---|
docs | AWS S3 binding spec | AWS S3 | Detailed documentation on the AWS S3 binding component |
Component format
To setup AWS S3 binding create a component of type bindings.aws.s3
. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
See [Authenticating to AWS]({{< ref authenticating-aws.md >}}) for information about authentication-related attributes
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.aws.s3
version: v1
metadata:
- name: bucket
value: mybucket
- name: region
value: us-west-2
- name: accessKey
value: *****************
- name: secretKey
value: *****************
- name: bucket
value: mybucket
{{% alert title="Warning" color="warning" %}} The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}). {{% /alert %}}
Spec metadata fields
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
bucket | Y | Output | The name of the S3 bucket to write to | "bucket" |
region | Y | Output | The specific AWS region | "us-east-1" |
accessKey | Y | Output | The AWS Access Key to access this resource | "key" |
secretKey | Y | Output | The AWS Secret Access Key to access this resource | "secretAccessKey" |
sessionToken | N | Output | The AWS session token to use | "sessionToken" |
Binding support
This component supports output binding with the folowing operations:
create
Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- [Bindings building block]({{< ref bindings >}})
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
- [Bindings API reference]({{< ref bindings_api.md >}})
- [Authenticating to AWS]({{< ref authenticating-aws.md >}})