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