Microsoft.Orleans.Persistence.DynamoDB 9.2.0-preview3

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-preview3
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Persistence.DynamoDB -Version 9.2.0-preview3
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-preview3" />
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-preview3" />
                    


                            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-preview3
                    


                    

                
#r "nuget: Microsoft.Orleans.Persistence.DynamoDB, 9.2.0-preview3"
#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-preview3
#: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-preview3&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Persistence.DynamoDB&version=9.2.0-preview3&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 5,078 7/16/2025
9.2.0 599 7/14/2025
9.2.0-preview3 313 6/10/2025
9.2.0-preview2 178 6/4/2025
9.2.0-preview1 140 4/4/2025
9.1.2 39,862 2/13/2025
9.0.1 33,432 11/23/2024
9.0.0 1,113 11/14/2024
8.2.0 28,151 7/12/2024
8.2.0-preview1 209 5/22/2024
8.1.0 44,297 4/17/2024
8.1.0-preview3 256 3/11/2024
8.1.0-preview2 162 2/23/2024
8.1.0-preview1 171 2/13/2024
8.0.0 51,412 1/5/2024
8.0.0-rc2 282 12/20/2023
8.0.0-rc1 197 12/4/2023
7.2.7 187 10/15/2024
7.2.6 4,998 3/9/2024
7.2.5 218 2/22/2024
7.2.4 5,900 12/2/2023
7.2.3 15,463 11/3/2023
7.2.2 4,033 10/16/2023
7.2.1 12,580 7/11/2023
7.2.0 294 7/7/2023
7.1.2 22,981 4/19/2023
7.1.1 9,619 3/23/2023
7.1.0 4,139 2/1/2023
7.0.0 12,670 11/8/2022
7.0.0-rc2 346 10/19/2022
4.0.0-preview2 1,727 8/4/2022
4.0.0-preview1 2,101 2/10/2022
3.8.0 200 5/6/2025
3.8.0-preview5 235 5/12/2025
3.8.0-preview3 214 4/8/2025
3.8.0-preview2 123 4/4/2025
3.8.0-preview1 211 3/31/2025
3.7.2 3,656 5/10/2024
3.7.1 15,092 5/27/2023
3.7.0 1,797 3/23/2023
3.6.5 45,166 8/15/2022
3.6.4 553 8/10/2022
3.6.3 535 8/4/2022
3.6.2 16,419 4/15/2022
3.6.1 914 4/5/2022
3.6.0 8,084 1/20/2022
3.5.1 10,836 11/8/2021
3.5.0 17,473 9/3/2021
3.4.4 538 10/4/2021
3.4.3 6,536 6/3/2021
3.4.2 3,418 4/5/2021
3.4.1 11,571 2/3/2021
3.4.0 86,590 1/6/2021
3.4.0-rc1 537 12/9/2020
3.3.0 18,477 9/9/2020
3.3.0-rc2 516 9/2/2020
3.3.0-rc1 494 8/19/2020
3.2.2 6,143 7/22/2020
3.2.1 878 7/2/2020
3.2.0 1,390 6/4/2020
3.2.0-rc2 555 5/20/2020
3.2.0-rc1 516 5/7/2020
3.1.7 2,085 5/19/2020
3.1.6 6,067 4/16/2020
3.1.5 801 4/9/2020
3.1.4 1,306 3/26/2020
3.1.3 1,111 3/16/2020
3.1.2 3,114 3/5/2020
3.1.0 1,061 2/23/2020
3.1.0-rc3 602 2/13/2020
3.1.0-rc2 616 2/12/2020
3.1.0-rc1 637 2/10/2020
3.0.2 2,622 12/12/2019
3.0.1 861 11/27/2019
3.0.0 1,346 10/24/2019
3.0.0-rc2 666 10/16/2019
3.0.0-rc1 675 10/9/2019
3.0.0-beta1 1,310 8/16/2019
2.4.5 13,106 12/29/2019
2.4.4 1,244 11/27/2019
2.4.3 1,471 10/10/2019
2.4.2 5,827 8/31/2019
2.4.1 1,818 8/14/2019
2.4.0 1,599 8/8/2019
2.3.6 1,861 7/24/2019
2.3.5 5,291 6/14/2019
2.3.4 1,656 6/4/2019
2.3.3 1,357 6/2/2019
2.3.2 2,260 5/9/2019
2.3.1 1,480 4/26/2019
2.3.0 3,180 3/20/2019
2.3.0-rc2 757 3/13/2019
2.3.0-rc1 845 3/4/2019
2.2.4 2,475 2/25/2019
2.2.3 2,663 1/17/2019
2.2.0 1,545 12/13/2018
2.2.0-rc1 918 12/4/2018
2.2.0-beta1 1,049 10/21/2018
2.1.2 3,776 10/11/2018
2.1.0 1,753 9/28/2018
2.1.0-rc2 1,278 9/21/2018
2.1.0-rc1 1,274 9/14/2018
2.1.0-beta1 1,269 8/27/2018
2.0.0 8,766 3/28/2018
2.0.0-rc2 5,187 3/13/2018
2.0.0-rc1 1,276 2/26/2018
2.0.0-beta3 3,131 12/21/2017