Microsoft.Orleans.Persistence.DynamoDB 9.2.0-preview2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Orleans.Persistence.DynamoDB.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Microsoft.Orleans.Persistence.DynamoDB --version 9.2.0-preview2
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Persistence.DynamoDB -Version 9.2.0-preview2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Microsoft.Orleans.Persistence.DynamoDB" Version="9.2.0-preview2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Persistence.DynamoDB" Version="9.2.0-preview2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Persistence.DynamoDB" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Microsoft.Orleans.Persistence.DynamoDB --version 9.2.0-preview2
                    


                    

                
#r "nuget: Microsoft.Orleans.Persistence.DynamoDB, 9.2.0-preview2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Microsoft.Orleans.Persistence.DynamoDB@9.2.0-preview2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.0-preview2&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.0-preview2&prerelease
                    


                            Install as a Cake Tool

Microsoft Orleans Persistence for DynamoDB

Introduction

Microsoft Orleans Persistence for DynamoDB provides grain persistence for Microsoft Orleans using Amazon's DynamoDB. This allows your grains to persist their state in DynamoDB and reload it when they are reactivated.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.DynamoDB

Example - Configuring DynamoDB Persistence

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure DynamoDB as grain storage
            .AddDynamoDBGrainStorage(
                name: "dynamoStore",
                configureOptions: options =>
                {
                    options.AccessKey = "YOUR_AWS_ACCESS_KEY";
                    options.SecretKey = "YOUR_AWS_SECRET_KEY";
                    options.Region = "us-east-1";
                    options.TableName = "OrleansGrainState";
                    options.CreateIfNotExists = true;
                });
    });

// Run the host
await builder.RunAsync();

Example - Using Grain Storage in a Grain

// Define grain state class

public class MyGrainState
{
    public string Data { get; set; }
    public int Version { get; set; }
}

// Grain implementation that uses the DynamoDB storage
public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
{
    private readonly IPersistentState<MyGrainState> _state;

    public MyGrain([PersistentState("state", "dynamoStore")] IPersistentState<MyGrainState> state)
    {
        _state = state;
    }

    public async Task SetData(string data)
    {
        _state.State.Data = data;
        _state.State.Version++;
        await _state.WriteStateAsync();
    }

    public Task<string> GetData()
    {
        return Task.FromResult(_state.State.Data);
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.Orleans.Persistence.DynamoDB:

Package Downloads
Microsoft.Orleans.OrleansAWSUtils

Library of utility types for Amazon AWS of Microsoft Orleans.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.DynamoDB:

Repository Stars
PiotrJustyna/road-to-orleans
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
Version Downloads Last Updated
9.2.1 3,000 7/16/2025
9.2.0 551 7/14/2025
9.2.0-preview3 300 6/10/2025
9.2.0-preview2 162 6/4/2025
9.2.0-preview1 125 4/4/2025
9.1.2 38,925 2/13/2025
9.0.1 33,229 11/23/2024
9.0.0 1,098 11/14/2024
8.2.0 27,482 7/12/2024
8.2.0-preview1 192 5/22/2024
8.1.0 44,279 4/17/2024
8.1.0-preview3 243 3/11/2024
8.1.0-preview2 152 2/23/2024
8.1.0-preview1 156 2/13/2024
8.0.0 50,706 1/5/2024
8.0.0-rc2 269 12/20/2023
8.0.0-rc1 180 12/4/2023
7.2.7 168 10/15/2024
7.2.6 4,980 3/9/2024
7.2.5 205 2/22/2024
7.2.4 5,884 12/2/2023
7.2.3 14,991 11/3/2023
7.2.2 4,020 10/16/2023
7.2.1 12,562 7/11/2023
7.2.0 278 7/7/2023
7.1.2 22,897 4/19/2023
7.1.1 9,602 3/23/2023
7.1.0 4,123 2/1/2023
7.0.0 12,652 11/8/2022
7.0.0-rc2 331 10/19/2022
4.0.0-preview2 1,721 8/4/2022
4.0.0-preview1 2,083 2/10/2022
3.8.0 183 5/6/2025
3.8.0-preview5 224 5/12/2025
3.8.0-preview3 199 4/8/2025
3.8.0-preview2 122 4/4/2025
3.8.0-preview1 197 3/31/2025
3.7.2 3,581 5/10/2024
3.7.1 14,850 5/27/2023
3.7.0 1,779 3/23/2023
3.6.5 44,050 8/15/2022
3.6.4 533 8/10/2022
3.6.3 521 8/4/2022
3.6.2 16,394 4/15/2022
3.6.1 900 4/5/2022
3.6.0 8,061 1/20/2022
3.5.1 10,817 11/8/2021
3.5.0 17,454 9/3/2021
3.4.4 520 10/4/2021
3.4.3 6,519 6/3/2021
3.4.2 3,404 4/5/2021
3.4.1 11,569 2/3/2021
3.4.0 85,599 1/6/2021
3.4.0-rc1 521 12/9/2020
3.3.0 18,475 9/9/2020
3.3.0-rc2 491 9/2/2020
3.3.0-rc1 481 8/19/2020
3.2.2 6,130 7/22/2020
3.2.1 861 7/2/2020
3.2.0 1,377 6/4/2020
3.2.0-rc2 548 5/20/2020
3.2.0-rc1 499 5/7/2020
3.1.7 2,067 5/19/2020
3.1.6 6,064 4/16/2020
3.1.5 782 4/9/2020
3.1.4 1,293 3/26/2020
3.1.3 1,094 3/16/2020
3.1.2 3,099 3/5/2020
3.1.0 1,046 2/23/2020
3.1.0-rc3 582 2/13/2020
3.1.0-rc2 599 2/12/2020
3.1.0-rc1 629 2/10/2020
3.0.2 2,606 12/12/2019
3.0.1 847 11/27/2019
3.0.0 1,333 10/24/2019
3.0.0-rc2 642 10/16/2019
3.0.0-rc1 652 10/9/2019
3.0.0-beta1 1,283 8/16/2019
2.4.5 13,083 12/29/2019
2.4.4 1,199 11/27/2019
2.4.3 1,457 10/10/2019
2.4.2 5,791 8/31/2019
2.4.1 1,763 8/14/2019
2.4.0 1,545 8/8/2019
2.3.6 1,827 7/24/2019
2.3.5 5,265 6/14/2019
2.3.4 1,621 6/4/2019
2.3.3 1,329 6/2/2019
2.3.2 2,208 5/9/2019
2.3.1 1,452 4/26/2019
2.3.0 3,154 3/20/2019
2.3.0-rc2 724 3/13/2019
2.3.0-rc1 791 3/4/2019
2.2.4 2,405 2/25/2019
2.2.3 2,615 1/17/2019
2.2.0 1,522 12/13/2018
2.2.0-rc1 888 12/4/2018
2.2.0-beta1 1,015 10/21/2018
2.1.2 3,733 10/11/2018
2.1.0 1,734 9/28/2018
2.1.0-rc2 1,239 9/21/2018
2.1.0-rc1 1,254 9/14/2018
2.1.0-beta1 1,229 8/27/2018
2.0.0 8,725 3/28/2018
2.0.0-rc2 5,132 3/13/2018
2.0.0-rc1 1,245 2/26/2018
2.0.0-beta3 3,090 12/21/2017