github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/caches/s3.md (about) 1 --- 2 title: s3 3 type: cache 4 status: deprecated 5 --- 6 7 <!-- 8 THIS FILE IS AUTOGENERATED! 9 10 To make changes please edit the contents of: 11 lib/cache/s3.go 12 --> 13 14 import Tabs from '@theme/Tabs'; 15 import TabItem from '@theme/TabItem'; 16 17 :::warning DEPRECATED 18 This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives). 19 ::: 20 21 Stores each item in an S3 bucket as a file, where an item ID is the path of the 22 item within the bucket. 23 24 25 <Tabs defaultValue="common" values={[ 26 { label: 'Common', value: 'common', }, 27 { label: 'Advanced', value: 'advanced', }, 28 ]}> 29 30 <TabItem value="common"> 31 32 ```yaml 33 # Common config fields, showing default values 34 label: "" 35 s3: 36 bucket: "" 37 content_type: application/octet-stream 38 region: eu-west-1 39 ``` 40 41 </TabItem> 42 <TabItem value="advanced"> 43 44 ```yaml 45 # All config fields, showing default values 46 label: "" 47 s3: 48 bucket: "" 49 content_type: application/octet-stream 50 force_path_style_urls: false 51 timeout: 5s 52 retries: 3 53 region: eu-west-1 54 endpoint: "" 55 credentials: 56 profile: "" 57 id: "" 58 secret: "" 59 token: "" 60 role: "" 61 role_external_id: "" 62 ``` 63 64 </TabItem> 65 </Tabs> 66 67 ## Alternatives 68 69 This cache has been renamed to [`aws_s3`](/docs/components/caches/aws_s3). 70 71 It is not possible to atomically upload S3 objects exclusively when the target 72 does not already exist, therefore this cache is not suitable for deduplication. 73 74 ### Credentials 75 76 By default Benthos will use a shared credentials file when connecting to AWS 77 services. It's also possible to set them explicitly at the component level, 78 allowing you to transfer data across accounts. You can find out more 79 [in this document](/docs/guides/cloud/aws). 80 81 ## Fields 82 83 ### `bucket` 84 85 The S3 bucket to store items in. 86 87 88 Type: `string` 89 Default: `""` 90 91 ### `content_type` 92 93 The content type to set for each item. 94 95 96 Type: `string` 97 Default: `"application/octet-stream"` 98 99 ### `force_path_style_urls` 100 101 Forces the client API to use path style URLs, which helps when connecting to custom endpoints. 102 103 104 Type: `bool` 105 Default: `false` 106 107 ### `timeout` 108 109 The maximum period to wait on requests before abandoning it. 110 111 112 Type: `string` 113 Default: `"5s"` 114 115 ### `retries` 116 117 The maximum number of retry attempts to make before abandoning a request. 118 119 120 Type: `int` 121 Default: `3` 122 123 ### `region` 124 125 The AWS region to target. 126 127 128 Type: `string` 129 Default: `"eu-west-1"` 130 131 ### `endpoint` 132 133 Allows you to specify a custom endpoint for the AWS API. 134 135 136 Type: `string` 137 Default: `""` 138 139 ### `credentials` 140 141 Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/cloud/aws). 142 143 144 Type: `object` 145 146 ### `credentials.profile` 147 148 A profile from `~/.aws/credentials` to use. 149 150 151 Type: `string` 152 Default: `""` 153 154 ### `credentials.id` 155 156 The ID of credentials to use. 157 158 159 Type: `string` 160 Default: `""` 161 162 ### `credentials.secret` 163 164 The secret for the credentials being used. 165 166 167 Type: `string` 168 Default: `""` 169 170 ### `credentials.token` 171 172 The token for the credentials being used, required when using short term credentials. 173 174 175 Type: `string` 176 Default: `""` 177 178 ### `credentials.role` 179 180 A role ARN to assume. 181 182 183 Type: `string` 184 Default: `""` 185 186 ### `credentials.role_external_id` 187 188 An external ID to provide when assuming a role. 189 190 191 Type: `string` 192 Default: `""` 193 194