github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/caches/dynamodb.md (about)

     1  ---
     2  title: dynamodb
     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/dynamodb.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 key/value pairs as a single document in a DynamoDB table. The key is
    22  stored as a string value and used as the table hash key. The value is stored as
    23  a binary value using the `data_key` field name.
    24  
    25  
    26  <Tabs defaultValue="common" values={[
    27    { label: 'Common', value: 'common', },
    28    { label: 'Advanced', value: 'advanced', },
    29  ]}>
    30  
    31  <TabItem value="common">
    32  
    33  ```yaml
    34  # Common config fields, showing default values
    35  label: ""
    36  dynamodb:
    37    table: ""
    38    hash_key: ""
    39    data_key: ""
    40    region: eu-west-1
    41  ```
    42  
    43  </TabItem>
    44  <TabItem value="advanced">
    45  
    46  ```yaml
    47  # All config fields, showing default values
    48  label: ""
    49  dynamodb:
    50    table: ""
    51    hash_key: ""
    52    data_key: ""
    53    consistent_read: false
    54    ttl: ""
    55    ttl_key: ""
    56    region: eu-west-1
    57    endpoint: ""
    58    credentials:
    59      profile: ""
    60      id: ""
    61      secret: ""
    62      token: ""
    63      role: ""
    64      role_external_id: ""
    65    max_retries: 3
    66    backoff:
    67      initial_interval: 1s
    68      max_interval: 5s
    69      max_elapsed_time: 30s
    70  ```
    71  
    72  </TabItem>
    73  </Tabs>
    74  
    75  ## Alternatives
    76  
    77  This cache has been renamed to [`aws_dynamodb`](/docs/components/caches/aws_dynamodb).
    78  
    79  A prefix can be specified to allow multiple cache types to share a single
    80  DynamoDB table. An optional TTL duration (`ttl`) and field
    81  (`ttl_key`) can be specified if the backing table has TTL enabled.
    82  
    83  Strong read consistency can be enabled using the `consistent_read`
    84  configuration field.
    85  
    86  ### Credentials
    87  
    88  By default Benthos will use a shared credentials file when connecting to AWS
    89  services. It's also possible to set them explicitly at the component level,
    90  allowing you to transfer data across accounts. You can find out more
    91  [in this document](/docs/guides/cloud/aws).
    92  
    93  ## Fields
    94  
    95  ### `table`
    96  
    97  The table to store items in.
    98  
    99  
   100  Type: `string`  
   101  Default: `""`  
   102  
   103  ### `hash_key`
   104  
   105  The key of the table column to store item keys within.
   106  
   107  
   108  Type: `string`  
   109  Default: `""`  
   110  
   111  ### `data_key`
   112  
   113  The key of the table column to store item values within.
   114  
   115  
   116  Type: `string`  
   117  Default: `""`  
   118  
   119  ### `consistent_read`
   120  
   121  Whether to use strongly consistent reads on Get commands.
   122  
   123  
   124  Type: `bool`  
   125  Default: `false`  
   126  
   127  ### `ttl`
   128  
   129  An optional TTL to set for items, calculated from the moment the item is cached.
   130  
   131  
   132  Type: `string`  
   133  Default: `""`  
   134  
   135  ### `ttl_key`
   136  
   137  The column key to place the TTL value within.
   138  
   139  
   140  Type: `string`  
   141  Default: `""`  
   142  
   143  ### `region`
   144  
   145  The AWS region to target.
   146  
   147  
   148  Type: `string`  
   149  Default: `"eu-west-1"`  
   150  
   151  ### `endpoint`
   152  
   153  Allows you to specify a custom endpoint for the AWS API.
   154  
   155  
   156  Type: `string`  
   157  Default: `""`  
   158  
   159  ### `credentials`
   160  
   161  Optional manual configuration of AWS credentials to use. More information can be found [in this document](/docs/guides/cloud/aws).
   162  
   163  
   164  Type: `object`  
   165  
   166  ### `credentials.profile`
   167  
   168  A profile from `~/.aws/credentials` to use.
   169  
   170  
   171  Type: `string`  
   172  Default: `""`  
   173  
   174  ### `credentials.id`
   175  
   176  The ID of credentials to use.
   177  
   178  
   179  Type: `string`  
   180  Default: `""`  
   181  
   182  ### `credentials.secret`
   183  
   184  The secret for the credentials being used.
   185  
   186  
   187  Type: `string`  
   188  Default: `""`  
   189  
   190  ### `credentials.token`
   191  
   192  The token for the credentials being used, required when using short term credentials.
   193  
   194  
   195  Type: `string`  
   196  Default: `""`  
   197  
   198  ### `credentials.role`
   199  
   200  A role ARN to assume.
   201  
   202  
   203  Type: `string`  
   204  Default: `""`  
   205  
   206  ### `credentials.role_external_id`
   207  
   208  An external ID to provide when assuming a role.
   209  
   210  
   211  Type: `string`  
   212  Default: `""`  
   213  
   214  ### `max_retries`
   215  
   216  The maximum number of retries before giving up on the request. If set to zero there is no discrete limit.
   217  
   218  
   219  Type: `int`  
   220  Default: `3`  
   221  
   222  ### `backoff`
   223  
   224  Control time intervals between retry attempts.
   225  
   226  
   227  Type: `object`  
   228  
   229  ### `backoff.initial_interval`
   230  
   231  The initial period to wait between retry attempts.
   232  
   233  
   234  Type: `string`  
   235  Default: `"1s"`  
   236  
   237  ### `backoff.max_interval`
   238  
   239  The maximum period to wait between retry attempts.
   240  
   241  
   242  Type: `string`  
   243  Default: `"5s"`  
   244  
   245  ### `backoff.max_elapsed_time`
   246  
   247  The maximum period to wait before retry attempts are abandoned. If zero then no limit is used.
   248  
   249  
   250  Type: `string`  
   251  Default: `"30s"`  
   252  
   253