mirror of https://github.com/dapr/docs.git
				
				
				
			Added DynamoDB state store doc
This commit is contained in:
		
							parent
							
								
									7f37a4914f
								
							
						
					
					
						commit
						8ffafddb0c
					
				|  | @ -24,6 +24,12 @@ no_list: true | |||
| | [Redis]({{< ref setup-redis.md >}})                            | ✅   | ✅            |  Alpha  | | ||||
| | [Zookeeper]({{< ref setup-zookeeper.md >}})                    | ✅   | ❌            |  Alpha  | | ||||
| 
 | ||||
| 
 | ||||
| ### Amazon Web Services (AWS) | ||||
| | Name                                                  | CRUD | Transactional | Status | | ||||
| |-------------------------------------------------------|------|---------------|--------| | ||||
| | [AWS DynamoDB]({{< ref setup-dynamodb.md >}})                      | ✅   | ❌            |  Alpha  | | ||||
| 
 | ||||
| ### Google Cloud Platform (GCP) | ||||
| | Name                                                  | CRUD | Transactional | Status | | ||||
| |-------------------------------------------------------|------|---------------|--------| | ||||
|  |  | |||
|  | @ -0,0 +1,58 @@ | |||
| --- | ||||
| type: docs | ||||
| title: "DynamoDB" | ||||
| linkTitle: "DynamoDB" | ||||
| description: Detailed information on the AWS DynamoDB state store component | ||||
| --- | ||||
| 
 | ||||
| ## Component format | ||||
| 
 | ||||
| To setup a DynamoDB state store create a component of type `state.dynamodb`. See [this guide]({{< ref "howto-get-save-state.md#step-1-setup-a-state-store" >}}) on how to create and apply a state store configuration. | ||||
| 
 | ||||
| ```yaml | ||||
| apiVersion: dapr.io/v1alpha1 | ||||
| kind: Component | ||||
| metadata: | ||||
|   name: <NAME> | ||||
|   namespace: <NAMESPACE> | ||||
| spec: | ||||
|   type: state.dynamodb | ||||
|   version: v1 | ||||
|   metadata: | ||||
|   - name: table | ||||
|     value: "mytable" | ||||
|   - name: accessKey | ||||
|     value: "abcd" | ||||
|   - name: secretKey | ||||
|     value: "abcd" | ||||
|   - name: endpoint | ||||
|     value: "http://localhost:8080" | ||||
|   - name: region | ||||
|     value: "eu-west-1" | ||||
|   - name: sessionToken | ||||
|     value: "abcd" | ||||
| ``` | ||||
| 
 | ||||
| {{% 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 | Details | Example | | ||||
| |--------------------|:--------:|---------|---------| | ||||
| | table              | Y  | name of the DynamoDB table to use  | `"mytable"` | ||||
| | accessKey          | N  | ID of the AWS account with appropriate permissions to SNS and SQS. Can be `secretKeyRef` to use a secret reference  | `"AKIAIOSFODNN7EXAMPLE"` | ||||
| | secretKey          | N  | Secret for the AWS user. Can be `secretKeyRef` to use a secret reference   |`"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | ||||
| | region             | N  | The AWS region to the instance. See this page for valid regions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html. Ensure that DynamoDB are available in that region.| `"us-east-1"` | ||||
| | endpoint          | N  |AWS endpoint for the component to use. Only used for local development. The `endpoint` is unncessary when running against production AWS   | `"http://localhost:4566"` | ||||
| | sessionToken      | N  |AWS session token to use.  A session token is only required if you are using temporary security credentials. | `"TOKEN"` | ||||
| 
 | ||||
| ## Setup AWS DynamoDB | ||||
| See [Authenticating to AWS]({{< ref authenticating-aws.md >}}) for information about authentication-related attributes | ||||
| 
 | ||||
| ## Related links | ||||
| - [Basic schema for a Dapr component]({{< ref component-schema >}}) | ||||
| - Read [this guide]({{< ref "howto-get-save-state.md#step-2-save-and-retrieve-a-single-state" >}}) for instructions on configuring state store components | ||||
| - [State management building block]({{< ref state-management >}}) | ||||
| - [Authenticating to AWS]({{< ref authenticating-aws.md >}}) | ||||
		Loading…
	
		Reference in New Issue